Skip to content
This repository has been archived by the owner on Jul 19, 2022. It is now read-only.

Commit

Permalink
More javadoc fixes.
Browse files Browse the repository at this point in the history
  • Loading branch information
d4rken committed Mar 4, 2018
1 parent d1b8854 commit 7919443
Show file tree
Hide file tree
Showing 6 changed files with 10 additions and 10 deletions.
4 changes: 2 additions & 2 deletions myolib/src/main/java/eu/darken/myolib/BaseMyo.java
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ public String getDeviceAddress() {

/**
* Requires API21+ (Lollipop+)
* Calling this on < API21 will have no effect.<br>
* Calling this on &lt; API21 will have no effect.<br>
* Changes the connection speed of this Myo.
* This can be done on the fly.
*
Expand Down Expand Up @@ -304,7 +304,7 @@ public void submit(@NonNull MyoMsg msg) {
* "Starts this Myo"<br>
* Launches the innerloop that dispatches {@link MyoMsg}.
* This loop will wait until {@link #getConnectionState()} changes to {@link eu.darken.myolib.BaseMyo.ConnectionState#CONNECTED}
* <p/>
* <p>
* Calling this multiple times has no effect.
*/
public void connect() {
Expand Down
4 changes: 2 additions & 2 deletions myolib/src/main/java/eu/darken/myolib/Myo.java
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ public interface ReadDeviceNameCallback {
private String mDeviceName;

/**
* Returns a cached devicename, call {@link #readDeviceName(ReadDeviceNameCallback)} to update it.<br/>
* Returns a cached devicename, call {@link #readDeviceName(ReadDeviceNameCallback)} to update it.<br>
* Is also updated on successfull {@link #writeDeviceName(String, MyoCommandCallback)} calls.
*
*/
Expand All @@ -89,7 +89,7 @@ public String getDeviceName() {
}

/**
* Reads the current device name through from the device.<br/>
* Reads the current device name through from the device.<br>
* While there also is {@link BluetoothDevice#getName()} it often only returns a short version of the name.
*
* @param callback optional
Expand Down
4 changes: 2 additions & 2 deletions myolib/src/main/java/eu/darken/myolib/msgs/MyoMsg.java
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ public enum State {
* {@link eu.darken.myolib.services.Emg}<br>
* {@link eu.darken.myolib.services.Generic}<br>
* {@link eu.darken.myolib.services.Imu}<br>
* <p/>
* <p>
*
* @param serviceUUID e.g. {@link MyoService#getServiceUUID()} or {@link MyoCharacteristic#getServiceUUID()}
* @param characteristicUUID e.g. {@link MyoCharacteristic#getCharacteristicUUID()}
Expand Down Expand Up @@ -143,7 +143,7 @@ public int getRetryCounter() {
* {@link #getGattStatus()} != {@link android.bluetooth.BluetoothGatt#GATT_SUCCESS} <br>
* after a transmission.
*
* @param retryCounter -1 for infinite tries otherwise >=0 tries
* @param retryCounter -1 for infinite tries otherwise &gt;=0 tries
*/
public void setRetryCounter(int retryCounter) {
mRetryCounter = retryCounter;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,11 +30,11 @@ public interface Processor {
List<UUID> getSubscriptions();

/**
* Will be called when new data arrived that this processor is subscribed for.<br/>
* Will be called when new data arrived that this processor is subscribed for.<br>
* 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! <br/>
* of {@link eu.darken.myolib.BaseMyo} and can lead to packet loss! <br>
* It is strongly recommended to just add the packet to a data structure and process it on a
* different thread.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
import eu.darken.myolib.services.Emg;

/**
* Creates {@link EmgData} objects from {@link BaseDataPacket} objects.<br/>
* Creates {@link EmgData} objects from {@link BaseDataPacket} objects.<br>
* More specifically, two for each.
*/
public class EmgProcessor extends BaseProcessor {
Expand Down
2 changes: 1 addition & 1 deletion myolib/src/main/java/eu/darken/myolib/tools/ApiHelper.java
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
public class ApiHelper {

/**
* @return if >=21
* @return if &gt;=21
*/
public static boolean hasLolliPop() {
return Build.VERSION.SDK_INT >= Build.VERSION_CODES.LOLLIPOP;
Expand Down

0 comments on commit 7919443

Please sign in to comment.