From 7919443e1d578de677292095d0a46ae2a3a24263 Mon Sep 17 00:00:00 2001 From: darken Date: Sun, 4 Mar 2018 13:45:24 +0100 Subject: [PATCH] More javadoc fixes. --- myolib/src/main/java/eu/darken/myolib/BaseMyo.java | 4 ++-- myolib/src/main/java/eu/darken/myolib/Myo.java | 4 ++-- myolib/src/main/java/eu/darken/myolib/msgs/MyoMsg.java | 4 ++-- .../src/main/java/eu/darken/myolib/processor/Processor.java | 4 ++-- .../java/eu/darken/myolib/processor/emg/EmgProcessor.java | 2 +- myolib/src/main/java/eu/darken/myolib/tools/ApiHelper.java | 2 +- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/myolib/src/main/java/eu/darken/myolib/BaseMyo.java b/myolib/src/main/java/eu/darken/myolib/BaseMyo.java index 708c70a..4144326 100644 --- a/myolib/src/main/java/eu/darken/myolib/BaseMyo.java +++ b/myolib/src/main/java/eu/darken/myolib/BaseMyo.java @@ -131,7 +131,7 @@ public String getDeviceAddress() { /** * Requires API21+ (Lollipop+) - * Calling this on < API21 will have no effect.
+ * Calling this on < API21 will have no effect.
* Changes the connection speed of this Myo. * This can be done on the fly. * @@ -304,7 +304,7 @@ public void submit(@NonNull MyoMsg msg) { * "Starts this Myo"
* Launches the innerloop that dispatches {@link MyoMsg}. * This loop will wait until {@link #getConnectionState()} changes to {@link eu.darken.myolib.BaseMyo.ConnectionState#CONNECTED} - *

+ *

* Calling this multiple times has no effect. */ public void connect() { diff --git a/myolib/src/main/java/eu/darken/myolib/Myo.java b/myolib/src/main/java/eu/darken/myolib/Myo.java index 1325b22..baf5892 100644 --- a/myolib/src/main/java/eu/darken/myolib/Myo.java +++ b/myolib/src/main/java/eu/darken/myolib/Myo.java @@ -80,7 +80,7 @@ public interface ReadDeviceNameCallback { private String mDeviceName; /** - * Returns a cached devicename, call {@link #readDeviceName(ReadDeviceNameCallback)} to update it.
+ * Returns a cached devicename, call {@link #readDeviceName(ReadDeviceNameCallback)} to update it.
* Is also updated on successfull {@link #writeDeviceName(String, MyoCommandCallback)} calls. * */ @@ -89,7 +89,7 @@ public String getDeviceName() { } /** - * Reads the current device name through from the device.
+ * Reads the current device name through from the device.
* While there also is {@link BluetoothDevice#getName()} it often only returns a short version of the name. * * @param callback optional diff --git a/myolib/src/main/java/eu/darken/myolib/msgs/MyoMsg.java b/myolib/src/main/java/eu/darken/myolib/msgs/MyoMsg.java index 8066e67..3da0481 100644 --- a/myolib/src/main/java/eu/darken/myolib/msgs/MyoMsg.java +++ b/myolib/src/main/java/eu/darken/myolib/msgs/MyoMsg.java @@ -61,7 +61,7 @@ public enum State { * {@link eu.darken.myolib.services.Emg}
* {@link eu.darken.myolib.services.Generic}
* {@link eu.darken.myolib.services.Imu}
- *

+ *

* * @param serviceUUID e.g. {@link MyoService#getServiceUUID()} or {@link MyoCharacteristic#getServiceUUID()} * @param characteristicUUID e.g. {@link MyoCharacteristic#getCharacteristicUUID()} @@ -143,7 +143,7 @@ public int getRetryCounter() { * {@link #getGattStatus()} != {@link android.bluetooth.BluetoothGatt#GATT_SUCCESS}
* after a transmission. * - * @param retryCounter -1 for infinite tries otherwise >=0 tries + * @param retryCounter -1 for infinite tries otherwise >=0 tries */ public void setRetryCounter(int retryCounter) { mRetryCounter = retryCounter; diff --git a/myolib/src/main/java/eu/darken/myolib/processor/Processor.java b/myolib/src/main/java/eu/darken/myolib/processor/Processor.java index e7178c9..9f3e70b 100644 --- a/myolib/src/main/java/eu/darken/myolib/processor/Processor.java +++ b/myolib/src/main/java/eu/darken/myolib/processor/Processor.java @@ -30,11 +30,11 @@ public interface Processor { List getSubscriptions(); /** - * Will be called when new data arrived that this processor is subscribed for.
+ * Will be called when new data arrived that this processor is subscribed for.
* Don't execute expensive routines inside this method! * Spending too much time in this method blocks the * {@link android.bluetooth.BluetoothGattCallback#onCharacteristicChanged(BluetoothGatt, BluetoothGattCharacteristic)} - * of {@link eu.darken.myolib.BaseMyo} and can lead to packet loss!
+ * of {@link eu.darken.myolib.BaseMyo} and can lead to packet loss!
* It is strongly recommended to just add the packet to a data structure and process it on a * different thread. * diff --git a/myolib/src/main/java/eu/darken/myolib/processor/emg/EmgProcessor.java b/myolib/src/main/java/eu/darken/myolib/processor/emg/EmgProcessor.java index 5ab2ccf..17c3984 100644 --- a/myolib/src/main/java/eu/darken/myolib/processor/emg/EmgProcessor.java +++ b/myolib/src/main/java/eu/darken/myolib/processor/emg/EmgProcessor.java @@ -10,7 +10,7 @@ import eu.darken.myolib.services.Emg; /** - * Creates {@link EmgData} objects from {@link BaseDataPacket} objects.
+ * Creates {@link EmgData} objects from {@link BaseDataPacket} objects.
* More specifically, two for each. */ public class EmgProcessor extends BaseProcessor { diff --git a/myolib/src/main/java/eu/darken/myolib/tools/ApiHelper.java b/myolib/src/main/java/eu/darken/myolib/tools/ApiHelper.java index 06ba472..609c321 100644 --- a/myolib/src/main/java/eu/darken/myolib/tools/ApiHelper.java +++ b/myolib/src/main/java/eu/darken/myolib/tools/ApiHelper.java @@ -13,7 +13,7 @@ public class ApiHelper { /** - * @return if >=21 + * @return if >=21 */ public static boolean hasLolliPop() { return Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP;