1
0
Fork 0
mirror of https://github.com/vanitasvitae/Smack.git synced 2025-12-12 22:11:07 +01:00

Fix javadoc issues in some packages

This commit is contained in:
Paul Schaub 2017-12-23 20:21:19 +01:00
parent cb18056613
commit 52398b535f
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311
50 changed files with 255 additions and 56 deletions

View file

@ -69,6 +69,7 @@ public class ItemPublishEvent<T extends Item> extends SubscriptionEvent
* @param nodeId The id of the node the event came from
* @param eventItems The list of {@link Item} that were published
* @param subscriptionIds The list of subscriptionIds
* @param publishedDate date of publication.
*/
public ItemPublishEvent(String nodeId, List<T> eventItems, List<String> subscriptionIds, Date publishedDate)
{
@ -107,7 +108,8 @@ public class ItemPublishEvent<T extends Item> extends SubscriptionEvent
/**
* Gets the original date the items were published. This is only
* valid if {@link #isDelayed()} is true.
*
*
* @return date of publication.
*/
public Date getPublishedDate()
{

View file

@ -111,6 +111,7 @@ public class ItemsExtension extends NodeExtension implements EmbeddedPacketExten
*
* @param nodeId The node to which the items are being sent or deleted
* @param items The list of {@link Item} or {@link RetractItem}
* @param notify
*/
public ItemsExtension(String nodeId, List<? extends ExtensionElement> items, boolean notify)
{
@ -140,7 +141,7 @@ public class ItemsExtension extends NodeExtension implements EmbeddedPacketExten
/**
* Gets the items related to the type of request or event.
*
* return List of {@link Item}, {@link RetractItem}, or null
* @return List of {@link Item}, {@link RetractItem}, or null
*/
public List<? extends ExtensionElement> getItems()
{

View file

@ -64,7 +64,8 @@ public class LeafNode extends Node
/**
* Get the current items stored in the node.
*
*
* @param <T> type of the items.
* @return List of {@link Item} in the node
* @throws XMPPErrorException
* @throws NoResponseException if there was no response from the server.
@ -83,6 +84,8 @@ public class LeafNode extends Node
*
* @param subscriptionId - The subscription id for the
* associated subscription.
* @param <T> type of the items.
*
* @return List of {@link Item} in the node
* @throws XMPPErrorException
* @throws NoResponseException if there was no response from the server.
@ -103,7 +106,8 @@ public class LeafNode extends Node
* event, that did not include the payload.
*
* @param ids Item ids of the items to retrieve
*
* @param <T> type of the items.
*
* @return The list of {@link Item} with payload
* @throws XMPPErrorException
* @throws NoResponseException if there was no response from the server.
@ -126,7 +130,8 @@ public class LeafNode extends Node
* Get items persisted on the node, limited to the specified number.
*
* @param maxItems Maximum number of items to return
*
* @param <T> type of the items.
*
* @return List of {@link Item}
* @throws XMPPErrorException
* @throws NoResponseException if there was no response from the server.
@ -148,6 +153,8 @@ public class LeafNode extends Node
* on.
*
* @return List of {@link Item}
* @param <T> type of the items.
*
* @throws XMPPErrorException
* @throws NoResponseException if there was no response from the server.
* @throws NotConnectedException
@ -170,6 +177,8 @@ public class LeafNode extends Node
* This is an optional argument, if provided as null no extensions will be added.
* @param returnedExtensions a collection that will be filled with the returned packet
* extensions. This is an optional argument, if provided as null it won't be populated.
* @param <T> type of the items.
*
* @return List of {@link Item}
* @throws NoResponseException
* @throws XMPPErrorException
@ -236,6 +245,8 @@ public class LeafNode extends Node
* For synchronous calls use {@link #send(Item) send(Item))}.
*
* @param item - The item being sent
* @param <T> type of the items.
*
* @throws NotConnectedException
* @throws InterruptedException
*/
@ -259,6 +270,8 @@ public class LeafNode extends Node
* For synchronous calls use {@link #send(Collection) send(Collection))}.
*
* @param items - The collection of items being sent
* @param <T> type of the items.
*
* @throws NotConnectedException
* @throws InterruptedException
*/
@ -311,6 +324,8 @@ public class LeafNode extends Node
* For asynchronous calls, use {@link #publish(Item) publish(Item)}.
*
* @param item - The item being sent
* @param <T> type of the items.
*
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException
@ -337,6 +352,8 @@ public class LeafNode extends Node
* For asynchronous calls, use {@link #publish(Collection) publish(Collection))}.
*
* @param items - The collection of {@link Item} objects being sent
* @param <T> type of the items.
*
* @throws XMPPErrorException
* @throws NoResponseException
* @throws NotConnectedException

View file

@ -384,7 +384,10 @@ abstract public class Node
* {@link Subscription.State#unconfigured} - If the {@link Subscription#isConfigRequired()} is true,
* the caller must configure the subscription before messages will be received. If it is false
* the caller can configure it but is not required to do so.
*
* @param jid The jid to subscribe as.
* @param subForm
*
* @return The subscription
* @throws XMPPErrorException
* @throws NoResponseException
@ -434,7 +437,9 @@ abstract public class Node
/**
* Returns a SubscribeForm for subscriptions, from which you can create an answer form to be submitted
* via the {@link #sendConfigurationForm(Form)}.
*
*
* @param jid
*
* @return A subscription options form
* @throws XMPPErrorException
* @throws NoResponseException

View file

@ -225,6 +225,8 @@ public final class PubSubManager extends Manager {
* exception if it does not.
*
* @param id - The unique id of the node
* @param <T> type of the node.
*
* @return the node
* @throws XMPPErrorException The node does not exist
* @throws NoResponseException if there was no response from the server.
@ -390,6 +392,8 @@ public final class PubSubManager extends Manager {
*
* @param id The unique id of the node.
* @param item The item to publish.
* @param <I> type of the item.
*
* @return the LeafNode on which the item was published.
* @throws NoResponseException
* @throws XMPPErrorException