Skip to content

Commit 045ac74

Browse files
committed
More JavaDoc fixes and an important assignment fix
1 parent 3d4f20f commit 045ac74

5 files changed

Lines changed: 19 additions & 18 deletions

File tree

library/src/main/java/com/proxerme/library/connection/messenger/entity/ConferenceInfo.java

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@
88
import com.afollestad.bridge.annotations.Body;
99

1010
/**
11-
* The class that represents the ConferenceInfo ConferenceInfo entity.
12-
* This class is different to the {@link com.proxerme.library.connection.messenger.entity.Conference}
11+
* The class that represents the ConferenceInfo entity.
1312
*
1413
* @author Desnoo
1514
*/
@@ -48,10 +47,10 @@ public ConferenceInfo[] newArray(int size) {
4847
* The Constructor.
4948
*
5049
* @param topic The topic.
51-
* @param participants The amount of participants in this conferenceInfo.
52-
* @param firstMessageTime The time when the conferenceInfo started.
53-
* @param lastMessageTime The time when the last message of the conferenceInfo was sent.
54-
* @param leaderId The user id of the conferenceInfo leader.
50+
* @param participants The amount of participants in this conference.
51+
* @param firstMessageTime The time when the conference started.
52+
* @param lastMessageTime The time when the last message of the conference was sent.
53+
* @param leaderId The user id of the conference leader.
5554
*/
5655
public ConferenceInfo(@NonNull String topic, @IntRange(from = 2) int participants,
5756
@IntRange(from = 0) long firstMessageTime,
@@ -64,7 +63,7 @@ public ConferenceInfo(@NonNull String topic, @IntRange(from = 2) int participant
6463
}
6564

6665
/**
67-
* The Constructor parses the parcel.
66+
* The Constructor that parses the parcel.
6867
*
6968
* @param in The parcel to parse.
7069
*/
@@ -77,19 +76,19 @@ protected ConferenceInfo(Parcel in) {
7776
}
7877

7978
/**
80-
* Returns the Topic.
79+
* Returns the topic.
8180
*
82-
* @return The Topic.
81+
* @return The topic.
8382
**/
8483
@NonNull
8584
public String getTopic() {
8685
return topic;
8786
}
8887

8988
/**
90-
* Returns the Count.
89+
* Returns the amount of participants in this conference.
9190
*
92-
* @return The Count.
91+
* @return The amount.
9392
**/
9493
@IntRange(from = 2)
9594
public int getParticipants() {

library/src/main/java/com/proxerme/library/connection/messenger/entity/ConferenceInfoContainer.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ public ConferenceInfoContainer[] newArray(int size) {
2727
}
2828
};
2929

30-
@Body(name = "conferenceInfo")
30+
@Body(name = "conference")
3131
ConferenceInfo conferenceInfo;
3232
@Body(name = "users")
3333
ConferenceInfoUser[] participants;

library/src/main/java/com/proxerme/library/connection/messenger/entity/ConferenceInfoUser.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -71,19 +71,19 @@ protected ConferenceInfoUser(Parcel in) {
7171
}
7272

7373
/**
74-
* Returns the Username.
74+
* Returns the username.
7575
*
76-
* @return The Username.
76+
* @return The username.
7777
**/
7878
@NonNull
7979
public String getUsername() {
8080
return username;
8181
}
8282

8383
/**
84-
* Returns the Status.
84+
* Returns the status.
8585
*
86-
* @return The Status.
86+
* @return The status.
8787
**/
8888
@NonNull
8989
public String getStatus() {

library/src/main/java/com/proxerme/library/connection/messenger/result/ConferenceInfoResult.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
import com.proxerme.library.interfaces.ProxerResult;
88

99
/**
10-
* The class that represents the result of the {@link com.proxerme.library.connection.messenger.request.ConferenceInfoRequest}.
10+
* The class that represents the result of the
11+
* {@link com.proxerme.library.connection.messenger.request.ConferenceInfoRequest}.
1112
*
1213
* @author Desnoo
1314
*/

library/src/main/java/com/proxerme/library/connection/messenger/result/ConstantsResult.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
import com.proxerme.library.interfaces.ProxerResult;
88

99
/**
10-
* The class that represents the result of the {@link com.proxerme.library.connection.messenger.request.ConstantsRequest}.
10+
* The class that represents the result of the
11+
* {@link com.proxerme.library.connection.messenger.request.ConstantsRequest}.
1112
*
1213
* @author Desnoo
1314
*/

0 commit comments

Comments
 (0)