mirrors/nextcloud-talk-android
1
0
Fork 0
mirror of https://github.com/nextcloud/talk-android.git synced 2024-11-22 04:55:29 +03:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #4365 from nextcloud/backport/4346/stable-20.0

Browse source 
[stable-20.0] Fix ignored blank lines in Javadocs
This commit is contained in:
Marcel Hibbe 2024-10-23 10:38:39 +02:00 committed by GitHub
commit 37a317b676
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
11 changed files with 46 additions and 46 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
app/src/main/java/com/nextcloud/talk/call/CallParticipant.java
View file

@ -15,7 +15,7 @@ import org.webrtc.PeerConnection;
/** /**
* Model for (remote) call participants. * Model for (remote) call participants.
* * <p>
* This class keeps track of the state changes in a call participant and updates its data model as needed. View classes * This class keeps track of the state changes in a call participant and updates its data model as needed. View classes
* are expected to directly use the read-only data model. * are expected to directly use the read-only data model.
*/ */

2
app/src/main/java/com/nextcloud/talk/call/CallParticipantList.java
View file

@ -17,7 +17,7 @@ import java.util.Map;
/** /**
* Helper class to keep track of the participants in a call based on the signaling messages. * Helper class to keep track of the participants in a call based on the signaling messages.
* * <p>
* The CallParticipantList adds a listener for participant list messages as soon as it is created and starts tracking * The CallParticipantList adds a listener for participant list messages as soon as it is created and starts tracking
* the call participants until destroyed. Notifications about the changes can be received by adding an observer to the * the call participants until destroyed. Notifications about the changes can be received by adding an observer to the
* CallParticipantList; note that no sorting is guaranteed on the participants. * CallParticipantList; note that no sorting is guaranteed on the participants.

2
app/src/main/java/com/nextcloud/talk/call/CallParticipantListNotifier.java
View file

@ -15,7 +15,7 @@ import java.util.Set;
/** /**
* Helper class to register and notify CallParticipantList.Observers. * Helper class to register and notify CallParticipantList.Observers.
* * <p>
* This class is only meant for internal use by CallParticipantList; listeners must register themselves against * This class is only meant for internal use by CallParticipantList; listeners must register themselves against
* a CallParticipantList rather than against a CallParticipantListNotifier. * a CallParticipantList rather than against a CallParticipantListNotifier.
*/ */

16
app/src/main/java/com/nextcloud/talk/call/CallParticipantModel.java
View file

@ -17,23 +17,23 @@ import java.util.Objects;
/** /**
* Read-only data model for (remote) call participants. * Read-only data model for (remote) call participants.
* * <p>
* If the hand was never raised null is returned by "getRaisedHand()". Otherwise a RaisedHand object is returned with * If the hand was never raised null is returned by "getRaisedHand()". Otherwise a RaisedHand object is returned with
* the current state (raised or not) and the timestamp when the raised hand state last changed. * the current state (raised or not) and the timestamp when the raised hand state last changed.
* * <p>
* The received audio and video are available only if the participant is sending them and also has them enabled. * The received audio and video are available only if the participant is sending them and also has them enabled.
* Before a connection is established it is not known whether audio and video are available or not, so null is returned * Before a connection is established it is not known whether audio and video are available or not, so null is returned
* in that case (therefore it should not be autoboxed to a plain boolean without checking that). * in that case (therefore it should not be autoboxed to a plain boolean without checking that).
* * <p>
* Audio and video in screen shares, on the other hand, are always seen as available. * Audio and video in screen shares, on the other hand, are always seen as available.
* * <p>
* Actor type and actor id will be set only in Talk >= 20. * Actor type and actor id will be set only in Talk >= 20.
* * <p>
* Clients of the model can observe it with CallParticipantModel.Observer to be notified when any value changes. * Clients of the model can observe it with CallParticipantModel.Observer to be notified when any value changes.
* Getters called after receiving a notification are guaranteed to provide at least the value that triggered the * Getters called after receiving a notification are guaranteed to provide at least the value that triggered the
* notification, but it may return even a more up to date one (so getting the value again on the following * notification, but it may return even a more up to date one (so getting the value again on the following
* notification may return the same value as before). * notification may return the same value as before).
* * <p>
* Besides onChange(), which notifies about changes in the model values, CallParticipantModel.Observer provides * Besides onChange(), which notifies about changes in the model values, CallParticipantModel.Observer provides
* additional methods to be notified about one-time events that are not reflected in the model values, like reactions. * additional methods to be notified about one-time events that are not reflected in the model values, like reactions.
*/ */
@ -169,11 +169,11 @@ public class CallParticipantModel {
/** /**
* Adds an observer to be notified when any value changes. * Adds an observer to be notified when any value changes.
* * <p>
* The observer will be notified on the thread associated to the given handler. If no handler is given the * The observer will be notified on the thread associated to the given handler. If no handler is given the
* observer will be immediately notified on the same thread that changed the value; the observer will be * observer will be immediately notified on the same thread that changed the value; the observer will be
* immediately notified too if the thread of the handler is the same thread that changed the value. * immediately notified too if the thread of the handler is the same thread that changed the value.
* * <p>
* An observer is expected to be added only once. If the same observer is added again it will be notified just * An observer is expected to be added only once. If the same observer is added again it will be notified just
* once on the thread of the last handler. * once on the thread of the last handler.
* *

2
app/src/main/java/com/nextcloud/talk/call/MutableCallParticipantModel.java
View file

@ -13,7 +13,7 @@ import org.webrtc.PeerConnection;
/** /**
* Mutable data model for (remote) call participants. * Mutable data model for (remote) call participants.
* * <p>
* There is no synchronization when setting the values; if needed, it should be handled by the clients of the model. * There is no synchronization when setting the values; if needed, it should be handled by the clients of the model.
*/ */
public class MutableCallParticipantModel extends CallParticipantModel { public class MutableCallParticipantModel extends CallParticipantModel {

2
app/src/main/java/com/nextcloud/talk/signaling/LocalParticipantMessageNotifier.java
View file

@ -12,7 +12,7 @@ import java.util.Set;
/** /**
* Helper class to register and notify LocalParticipantMessageListeners. * Helper class to register and notify LocalParticipantMessageListeners.
* * <p>
* This class is only meant for internal use by SignalingMessageReceiver; listeners must register themselves against * This class is only meant for internal use by SignalingMessageReceiver; listeners must register themselves against
* a SignalingMessageReceiver rather than against a LocalParticipantMessageNotifier. * a SignalingMessageReceiver rather than against a LocalParticipantMessageNotifier.
*/ */

2
app/src/main/java/com/nextcloud/talk/signaling/OfferMessageNotifier.java
View file

@ -12,7 +12,7 @@ import java.util.Set;
/** /**
* Helper class to register and notify OfferMessageListeners. * Helper class to register and notify OfferMessageListeners.
* * <p>
* This class is only meant for internal use by SignalingMessageReceiver; listeners must register themselves against * This class is only meant for internal use by SignalingMessageReceiver; listeners must register themselves against
* a SignalingMessageReceiver rather than against an OfferMessageNotifier. * a SignalingMessageReceiver rather than against an OfferMessageNotifier.
*/ */

2
app/src/main/java/com/nextcloud/talk/signaling/ParticipantListMessageNotifier.java
View file

@ -15,7 +15,7 @@ import java.util.Set;
/** /**
* Helper class to register and notify ParticipantListMessageListeners. * Helper class to register and notify ParticipantListMessageListeners.
* * <p>
* This class is only meant for internal use by SignalingMessageReceiver; listeners must register themselves against * This class is only meant for internal use by SignalingMessageReceiver; listeners must register themselves against
* a SignalingMessageReceiver rather than against a ParticipantListMessageNotifier. * a SignalingMessageReceiver rather than against a ParticipantListMessageNotifier.
*/ */

58
app/src/main/java/com/nextcloud/talk/signaling/SignalingMessageReceiver.java
View file

@ -20,20 +20,20 @@ import java.util.Map;
/** /**
* Hub to register listeners for signaling messages of different kinds. * Hub to register listeners for signaling messages of different kinds.
* * <p>
* In general, if a listener is added while an event is being handled the new listener will not receive that event. * In general, if a listener is added while an event is being handled the new listener will not receive that event.
* An exception to that is adding a WebRtcMessageListener when handling an offer in an OfferMessageListener; in that * An exception to that is adding a WebRtcMessageListener when handling an offer in an OfferMessageListener; in that
* case the "onOffer()" method of the WebRtcMessageListener will be called for that same offer. * case the "onOffer()" method of the WebRtcMessageListener will be called for that same offer.
* * <p>
* Similarly, if a listener is removed while an event is being handled the removed listener will still receive that * Similarly, if a listener is removed while an event is being handled the removed listener will still receive that
* event. Again the exception is removing a WebRtcMessageListener when handling an offer in an OfferMessageListener; in * event. Again the exception is removing a WebRtcMessageListener when handling an offer in an OfferMessageListener; in
* that case the "onOffer()" method of the WebRtcMessageListener will not be called for that offer. * that case the "onOffer()" method of the WebRtcMessageListener will not be called for that offer.
* * <p>
* Adding and removing listeners, as well as notifying them is internally synchronized. This should be kept in mind * Adding and removing listeners, as well as notifying them is internally synchronized. This should be kept in mind
* if listeners are added or removed when handling an event to prevent deadlocks (nevertheless, just adding or * if listeners are added or removed when handling an event to prevent deadlocks (nevertheless, just adding or
* removing a listener in the same thread handling the event is fine, and in most cases it will be fine too if done * removing a listener in the same thread handling the event is fine, and in most cases it will be fine too if done
* in a different thread, as long as the notifier thread is not forced to wait until the listener is added or removed). * in a different thread, as long as the notifier thread is not forced to wait until the listener is added or removed).
* * <p>
* SignalingMessageReceiver does not fetch the signaling messages itself; subclasses must fetch them and then call * SignalingMessageReceiver does not fetch the signaling messages itself; subclasses must fetch them and then call
* the appropriate protected methods to process the messages and notify the listeners. * the appropriate protected methods to process the messages and notify the listeners.
*/ */
@ -55,7 +55,7 @@ public abstract class SignalingMessageReceiver {
/** /**
* Listener for participant list messages. * Listener for participant list messages.
* * <p>
* The messages are implicitly bound to the room currently joined in the signaling server; listeners are expected * The messages are implicitly bound to the room currently joined in the signaling server; listeners are expected
* to know the current room. * to know the current room.
*/ */
@ -63,17 +63,17 @@ public abstract class SignalingMessageReceiver {
/** /**
* List of all the participants in the room. * List of all the participants in the room.
* * <p>
* This message is received only when the internal signaling server is used. * This message is received only when the internal signaling server is used.
* * <p>
* The message is received periodically, and the participants may not have been modified since the last message. * The message is received periodically, and the participants may not have been modified since the last message.
* * <p>
* Only the following participant properties are set: * Only the following participant properties are set:
* - inCall * - inCall
* - lastPing * - lastPing
* - sessionId * - sessionId
* - userId (if the participant is not a guest) * - userId (if the participant is not a guest)
* * <p>
* "participantPermissions" is provided in the message (since Talk 13), but not currently set in the * "participantPermissions" is provided in the message (since Talk 13), but not currently set in the
* participant. "publishingPermissions" was provided instead in Talk 12, but it was not used anywhere, so it is * participant. "publishingPermissions" was provided instead in Talk 12, but it was not used anywhere, so it is
* ignored. * ignored.
@ -84,25 +84,25 @@ public abstract class SignalingMessageReceiver {
/** /**
* List of all the participants in the call or the room (depending on what triggered the event). * List of all the participants in the call or the room (depending on what triggered the event).
* * <p>
* This message is received only when the external signaling server is used. * This message is received only when the external signaling server is used.
* * <p>
* The message is received when any participant changed, although what changed is not provided and should be * The message is received when any participant changed, although what changed is not provided and should be
* derived from the difference with previous messages. The list of participants may include only the * derived from the difference with previous messages. The list of participants may include only the
* participants in the call (including those that just left it and thus triggered the event) or all the * participants in the call (including those that just left it and thus triggered the event) or all the
* participants currently in the room (participants in the room but not currently active, that is, without a * participants currently in the room (participants in the room but not currently active, that is, without a
* session, are not included). * session, are not included).
* * <p>
* Only the following participant properties are set: * Only the following participant properties are set:
* - inCall * - inCall
* - lastPing * - lastPing
* - sessionId * - sessionId
* - type * - type
* - userId (if the participant is not a guest) * - userId (if the participant is not a guest)
* * <p>
* "nextcloudSessionId" is provided in the message (when the "inCall" property of any participant changed), but * "nextcloudSessionId" is provided in the message (when the "inCall" property of any participant changed), but
* not currently set in the participant. * not currently set in the participant.
* * <p>
* "participantPermissions" is provided in the message (since Talk 13), but not currently set in the * "participantPermissions" is provided in the message (since Talk 13), but not currently set in the
* participant. "publishingPermissions" was provided instead in Talk 12, but it was not used anywhere, so it is * participant. "publishingPermissions" was provided instead in Talk 12, but it was not used anywhere, so it is
* ignored. * ignored.
@ -113,7 +113,7 @@ public abstract class SignalingMessageReceiver {
/** /**
* Update of the properties of all the participants in the room. * Update of the properties of all the participants in the room.
* * <p>
* This message is received only when the external signaling server is used. * This message is received only when the external signaling server is used.
* *
* @param inCall the new value of the inCall property * @param inCall the new value of the inCall property
@ -123,17 +123,17 @@ public abstract class SignalingMessageReceiver {
/** /**
* Listener for local participant messages. * Listener for local participant messages.
* * <p>
* The messages are implicitly bound to the local participant (or, rather, its session); listeners are expected * The messages are implicitly bound to the local participant (or, rather, its session); listeners are expected
* to know the local participant. * to know the local participant.
* * <p>
* The messages are related to the conversation, so the local participant may or may not be in a call when they * The messages are related to the conversation, so the local participant may or may not be in a call when they
* are received. * are received.
*/ */
public interface LocalParticipantMessageListener { public interface LocalParticipantMessageListener {
/** /**
* Request for the client to switch to the given conversation. * Request for the client to switch to the given conversation.
* * <p>
* This message is received only when the external signaling server is used. * This message is received only when the external signaling server is used.
* *
* @param token the token of the conversation to switch to. * @param token the token of the conversation to switch to.
@ -143,10 +143,10 @@ public abstract class SignalingMessageReceiver {
/** /**
* Listener for call participant messages. * Listener for call participant messages.
* * <p>
* The messages are bound to a specific call participant (or, rather, session), so each listener is expected to * The messages are bound to a specific call participant (or, rather, session), so each listener is expected to
* handle messages only for a single call participant. * handle messages only for a single call participant.
* * <p>
* Although "unshareScreen" is technically bound to a specific peer connection it is instead treated as a general * Although "unshareScreen" is technically bound to a specific peer connection it is instead treated as a general
* message on the call participant. * message on the call participant.
*/ */
@ -166,11 +166,11 @@ public abstract class SignalingMessageReceiver {
/** /**
* Listener for WebRTC offers. * Listener for WebRTC offers.
* * <p>
* Unlike the WebRtcMessageListener, which is bound to a specific peer connection, an OfferMessageListener listens * Unlike the WebRtcMessageListener, which is bound to a specific peer connection, an OfferMessageListener listens
* to all offer messages, no matter which peer connection they are bound to. This can be used, for example, to * to all offer messages, no matter which peer connection they are bound to. This can be used, for example, to
* create a new peer connection when a remote offer for which there is no previous connection is received. * create a new peer connection when a remote offer for which there is no previous connection is received.
* * <p>
* When an offer is received all OfferMessageListeners are notified before any WebRtcMessageListener is notified. * When an offer is received all OfferMessageListeners are notified before any WebRtcMessageListener is notified.
*/ */
public interface OfferMessageListener { public interface OfferMessageListener {
@ -179,7 +179,7 @@ public abstract class SignalingMessageReceiver {
/** /**
* Listener for WebRTC messages. * Listener for WebRTC messages.
* * <p>
* The messages are bound to a specific peer connection, so each listener is expected to handle messages only for * The messages are bound to a specific peer connection, so each listener is expected to handle messages only for
* a single peer connection. * a single peer connection.
*/ */
@ -192,7 +192,7 @@ public abstract class SignalingMessageReceiver {
/** /**
* Adds a listener for participant list messages. * Adds a listener for participant list messages.
* * <p>
* A listener is expected to be added only once. If the same listener is added again it will be notified just once. * A listener is expected to be added only once. If the same listener is added again it will be notified just once.
* *
* @param listener the ParticipantListMessageListener * @param listener the ParticipantListMessageListener
@ -207,7 +207,7 @@ public abstract class SignalingMessageReceiver {
/** /**
* Adds a listener for local participant messages. * Adds a listener for local participant messages.
* * <p>
* A listener is expected to be added only once. If the same listener is added again it will be notified just once. * A listener is expected to be added only once. If the same listener is added again it will be notified just once.
* *
* @param listener the LocalParticipantMessageListener * @param listener the LocalParticipantMessageListener
@ -222,7 +222,7 @@ public abstract class SignalingMessageReceiver {
/** /**
* Adds a listener for call participant messages. * Adds a listener for call participant messages.
* * <p>
* A listener is expected to be added only once. If the same listener is added again it will no longer be notified * A listener is expected to be added only once. If the same listener is added again it will no longer be notified
* for the messages from the previous session ID. * for the messages from the previous session ID.
* *
@ -247,7 +247,7 @@ public abstract class SignalingMessageReceiver {
/** /**
* Adds a listener for all offer messages. * Adds a listener for all offer messages.
* * <p>
* A listener is expected to be added only once. If the same listener is added again it will be notified just once. * A listener is expected to be added only once. If the same listener is added again it will be notified just once.
* *
* @param listener the OfferMessageListener * @param listener the OfferMessageListener
@ -262,7 +262,7 @@ public abstract class SignalingMessageReceiver {
/** /**
* Adds a listener for WebRTC messages from the given session ID and room type. * Adds a listener for WebRTC messages from the given session ID and room type.
* * <p>
* A listener is expected to be added only once. If the same listener is added again it will no longer be notified * A listener is expected to be added only once. If the same listener is added again it will no longer be notified
* for the messages from the previous session ID or room type. * for the messages from the previous session ID or room type.
* *
@ -475,7 +475,7 @@ public abstract class SignalingMessageReceiver {
/** /**
* Creates and initializes a Participant from the data in the given map. * Creates and initializes a Participant from the data in the given map.
* * <p>
* Maps from internal and external signaling server messages can be used. Nevertheless, besides the differences * Maps from internal and external signaling server messages can be used. Nevertheless, besides the differences
* between the messages and the optional properties, it is expected that the message is correct and the given data * between the messages and the optional properties, it is expected that the message is correct and the given data
* is parseable. Broken messages (for example, a string instead of an integer for "inCall" or a missing * is parseable. Broken messages (for example, a string instead of an integer for "inCall" or a missing

2
app/src/main/java/com/nextcloud/talk/webrtc/DataChannelMessageNotifier.java
View file

@ -12,7 +12,7 @@ import java.util.Set;
/** /**
* Helper class to register and notify DataChannelMessageListeners. * Helper class to register and notify DataChannelMessageListeners.
* * <p>
* This class is only meant for internal use by PeerConnectionWrapper; listeners must register themselves against * This class is only meant for internal use by PeerConnectionWrapper; listeners must register themselves against
* a PeerConnectionWrapper rather than against a DataChannelMessageNotifier. * a PeerConnectionWrapper rather than against a DataChannelMessageNotifier.
*/ */

2
app/src/main/java/com/nextcloud/talk/webrtc/PeerConnectionNotifier.java
View file

@ -15,7 +15,7 @@ import java.util.Set;
/** /**
* Helper class to register and notify PeerConnectionObserver. * Helper class to register and notify PeerConnectionObserver.
* * <p>
* This class is only meant for internal use by PeerConnectionWrapper; observers must register themselves against * This class is only meant for internal use by PeerConnectionWrapper; observers must register themselves against
* a PeerConnectionWrapper rather than against a PeerConnectionNotifier. * a PeerConnectionWrapper rather than against a PeerConnectionNotifier.
*/ */