diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemsExtension.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemsExtension.java index a21f9065a..69ec1b7af 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemsExtension.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/ItemsExtension.java @@ -21,14 +21,16 @@ import java.util.List; import org.jivesoftware.smack.packet.ExtensionElement; /** - * This class is used to for multiple purposes. + * This class is used for multiple purposes. + * * *

Please note, this class is used for internal purposes, and is not required for usage of - * pubsub functionality. + * pubsub functionality.

* * @author Robin Collier */ @@ -69,7 +71,8 @@ public class ItemsExtension extends NodeExtension implements EmbeddedPacketExten /** * Construct an instance with a list representing items that have been published or deleted. * - *

Valid scenarios are: + *

Valid scenarios are:

+ * * * @param itemsType Type of representation * @param nodeId The node to which the items are being sent or deleted @@ -93,7 +97,8 @@ public class ItemsExtension extends NodeExtension implements EmbeddedPacketExten /** * Construct an instance with a list representing items that have been published or deleted. * - *

Valid scenarios are: + *

Valid scenarios are:

+ * * * @param nodeId The node to which the items are being sent or deleted * @param items The list of {@link Item} or {@link RetractItem} diff --git a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PayloadItem.java b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PayloadItem.java index ec8112596..40e8e4131 100644 --- a/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PayloadItem.java +++ b/smack-extensions/src/main/java/org/jivesoftware/smackx/pubsub/PayloadItem.java @@ -25,21 +25,25 @@ import org.jivesoftware.smackx.pubsub.provider.ItemProvider; * pubsub node. An Item has several properties that are dependent * on the configuration of the node to which it has been or will be published. * - *

An Item received from a node (via {@link LeafNode#getItems()} or {@link LeafNode#addItemEventListener(org.jivesoftware.smackx.pubsub.listener.ItemEventListener)} + *

An Item received from a node (via {@link LeafNode#getItems()} or {@link LeafNode#addItemEventListener(org.jivesoftware.smackx.pubsub.listener.ItemEventListener)}

+ * * - *

An Item created to send to a node (via {@link LeafNode#send()} or {@link LeafNode#publish()} + *

An Item created to send to a node (via {@link LeafNode#send()} or {@link LeafNode#publish()}

+ * * *

To customise the payload object being returned from the {@link #getPayload()} method, you can - * add a custom parser as explained in {@link ItemProvider}. + * add a custom parser as explained in {@link ItemProvider}.

* * @author Robin Collier */ @@ -84,6 +88,7 @@ public class PayloadItem extends Item * one as part of {@link Message}. If used to create an Item to publish * (via {@link LeafNode#publish(Item)}, the server may return an * error for an invalid packet. + *

* * @param itemId The id of this item. * @param nodeId The id of the node the item was published to.