Skip to content

Commit ed5cd94

Browse files
committed
JavaDoc adjustments
1 parent 740bdb9 commit ed5cd94

2 files changed

Lines changed: 20 additions & 21 deletions

File tree

library/src/main/java/com/proxerme/library/connection/ProxerConnection.java

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -26,23 +26,22 @@
2626
/**
2727
* Entry point for all interaction with the API. Before using, the user has to build an instance
2828
* with the {@link Builder}.
29-
*
30-
* <br>This class features two important methods:
31-
*
32-
* <p>1) {@link #execute(ProxerRequest, ProxerCallback, ProxerErrorCallback)}
29+
* <br>
30+
* This class features two important methods:
31+
* <p>
32+
* 1) {@link #execute(ProxerRequest, ProxerCallback, ProxerErrorCallback)}
3333
* executes a passed {@link ProxerRequest} on a background thread. The results are returned to the
3434
* specified callbacks.
35-
*
36-
* <p>2) {@link #executeSynchronized(ProxerRequest)}
35+
* <p>
36+
* 2) {@link #executeSynchronized(ProxerRequest)}
3737
* executes a passed {@link ProxerRequest} on the same thread the method was invoked. This is useful
3838
* if the user wants to handle threading itself or is running code in a background thread already
3939
* (AsyncTask, IntentService, ...)
40-
*
41-
* <p>Both methods return their results on the main thread to make it possible to update views
40+
* <p>
41+
* Both methods return their results on the main thread to make it possible to update views
4242
* directly.
43-
*
44-
* <p>The usage of this class might look like this:
45-
*
43+
* <p>
44+
* The usage of this class might look like this:
4645
* <pre>
4746
* <code>
4847
* ProxerConnection connection = new ProxerConnection.Builder(context, "apiKey").build();

library/src/main/java/com/proxerme/library/connection/messenger/request/MessagesRequest.java

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,18 +17,18 @@
1717
/**
1818
* Request for loading messages. There are 4 different cases associated with the conferenceId and
1919
* messageId:
20-
*
21-
* <p>1) conferenceId = "0" and messageId = "0". The latest messages of the user are loaded.
22-
*
23-
* <br>2) conferenceId = "0" and messageId = X. The messages before the specified id are loaded.
24-
*
25-
* <br>3) conferenceId = X and messageId = "0". The latest messages in the specified conference are
20+
* <p>
21+
* 1) conferenceId = "0" and messageId = "0". The latest messages of the user are loaded.
22+
* <br>
23+
* 2) conferenceId = "0" and messageId = X. The messages before the specified id are loaded.
24+
* <br>
25+
* 3) conferenceId = X and messageId = "0". The latest messages in the specified conference are
2626
* loaded.
27-
*
28-
* <br>4) conferenceId = X and messageId = X. The messages before the specified messageId in the
27+
* <br>
28+
* 4) conferenceId = X and messageId = X. The messages before the specified messageId in the
2929
* specified conference are loaded.
30-
*
31-
* <p>This API requires the user to be logged in.
30+
* <p>
31+
* This API requires the user to be logged in.
3232
*
3333
* @author Ruben Gees
3434
*/

0 commit comments

Comments
 (0)