diff --git a/source/org/jivesoftware/smack/Roster.java b/source/org/jivesoftware/smack/Roster.java index 5f739fd20..32d4457da 100644 --- a/source/org/jivesoftware/smack/Roster.java +++ b/source/org/jivesoftware/smack/Roster.java @@ -405,9 +405,11 @@ public class Roster { * If the user has several presences (one for each resource), then the presence with * highest priority will be returned. If multiple presences have the same priority, * the one with the "most available" presence mode will be returned. In order, - * that's {@link Presence.Mode#chat free to chat}, {@link Presence.Mode#available available}, - * {@link Presence.Mode#away away}, {@link Presence.Mode#xa extended away}, and - * {@link Presence.Mode#dnd do not disturb}.
+ * that's {@link org.jivesoftware.smack.packet.Presence.Mode#chat free to chat}, + * {@link org.jivesoftware.smack.packet.Presence.Mode#available available}, + * {@link org.jivesoftware.smack.packet.Presence.Mode#away away}, + * {@link org.jivesoftware.smack.packet.Presence.Mode#xa extended away}, and + * {@link org.jivesoftware.smack.packet.Presence.Mode#dnd do not disturb}.
*
* Note that presence information is received asynchronously. So, just after logging * in to the server, presence values for users in the roster may be unavailable diff --git a/source/org/jivesoftware/smackx/PEPManager.java b/source/org/jivesoftware/smackx/PEPManager.java index 400664d20..a5b1d399e 100644 --- a/source/org/jivesoftware/smackx/PEPManager.java +++ b/source/org/jivesoftware/smackx/PEPManager.java @@ -70,7 +70,7 @@ public class PEPManager { /** * Creates a new PEP exchange manager. * - * @param con an XMPPConnection. + * @param connection an XMPPConnection. */ public PEPManager(XMPPConnection connection) { this.connection = connection; @@ -94,7 +94,7 @@ public class PEPManager { /** * Removes a listener from PEP events. * - * @param pepListener a roster exchange listener.. + * @param pepListener a roster exchange listener. */ public void removePEPListener(PEPListener pepListener) { synchronized (pepListeners) { @@ -105,8 +105,7 @@ public class PEPManager { /** * Publish an event. * - * @param roster the roster to send - * @param targetUserID the user that will receive the roster entries + * @param item the item to publish. */ public void publish(PEPItem item) { // Create a new message to publish the event. diff --git a/source/org/jivesoftware/smackx/commands/AdHocCommand.java b/source/org/jivesoftware/smackx/commands/AdHocCommand.java index 1affd1ef5..d1827b9e8 100755 --- a/source/org/jivesoftware/smackx/commands/AdHocCommand.java +++ b/source/org/jivesoftware/smackx/commands/AdHocCommand.java @@ -108,7 +108,7 @@ public abstract class AdHocCommand { * Set the the human readable name of the command, usually used for * displaying in a UI. * - * @param name + * @param name the name. */ public void setName(String name) { data.setName(name); @@ -148,7 +148,7 @@ public abstract class AdHocCommand { * Gets the full JID of the owner of this command. This JID is the "to" of a * execution request. * - * @return + * @return the owner JID. */ public abstract String getOwnerJID(); @@ -167,7 +167,7 @@ public abstract class AdHocCommand { * returned by thegetNotes
method during the current stage.
* Once the stage changes all the notes are discarded.
*
- * @param note
+ * @param note the note.
*/
protected void addNote(AdHocCommandNote note) {
data.addNote(note);
@@ -280,7 +280,7 @@ public abstract class AdHocCommand {
* Add an action to the current stage available actions. This should be used
* when creating a response.
*
- * @param action
+ * @param action the action.
*/
protected void addActionAvailable(Action action) {
data.addAction(action);
@@ -307,7 +307,7 @@ public abstract class AdHocCommand {
* in the command then the action will be assumed "execute" thus assuming
* the action returned by this method.
*
- * @param action
+ * @param action the action.
*/
protected void setExecuteAction(Action action) {
data.setExecuteAction(action);
@@ -316,7 +316,7 @@ public abstract class AdHocCommand {
/**
* Returns the status of the current stage.
*
- * @return
+ * @return the current status.
*/
public Status getStatus() {
return data.getStatus();
@@ -325,7 +325,7 @@ public abstract class AdHocCommand {
/**
* Sets the data of the current stage. This should not used.
*
- * @param data
+ * @param data the data.
*/
void setData(AdHocCommandData data) {
this.data = data;
@@ -333,8 +333,8 @@ public abstract class AdHocCommand {
/**
* Gets the data of the current stage. This should not used.
- *
- * @param data
+ *
+ * @return the data.
*/
AdHocCommandData getData() {
return data;
@@ -403,7 +403,7 @@ public abstract class AdHocCommand {
* The action is unknow. This is used when a recieved message has an
* unknown action. It must not be used to send an execution request.
*/
- unknown;
+ unknown
}
public enum SpecificErrorCondition {
diff --git a/source/org/jivesoftware/smackx/commands/LocalCommand.java b/source/org/jivesoftware/smackx/commands/LocalCommand.java
index 0b374490e..6ec3e203a 100755
--- a/source/org/jivesoftware/smackx/commands/LocalCommand.java
+++ b/source/org/jivesoftware/smackx/commands/LocalCommand.java
@@ -94,7 +94,7 @@ public abstract class LocalCommand extends AdHocCommand {
* Sets the JID of the command host. This is automatically handled and should
* not be called.
*
- * @param ownerJID
+ * @param ownerJID the JID of the owner.
*/
public void setOwnerJID(String ownerJID) {
this.ownerJID = ownerJID;
@@ -109,7 +109,7 @@ public abstract class LocalCommand extends AdHocCommand {
* Returns the time in milliseconds since this command was executed for
* first time.
*
- * @return
+ * @return the time in milliseconds since the command was executed for the first time.
*/
public long getCreationStamp() {
return creationStamp;
@@ -151,7 +151,7 @@ public abstract class LocalCommand extends AdHocCommand {
* Returns the currently executing stage number. The first stage number is
* 0. So during the execution of the first action this method will answer 0.
*
- * @return
+ * @return the current stage number.
*/
public int getCurrentStage() {
return currenStage;
@@ -164,7 +164,7 @@ public abstract class LocalCommand extends AdHocCommand {
* all the stages of the command. It is not checked again during the
* execution.
*
- * @param jid
+ * @param jid the JID to check permissions on.
* @return true if the user has permission to execute this action
*/
public abstract boolean hasPermission(String jid);
diff --git a/source/org/jivesoftware/smackx/commands/RemoteCommand.java b/source/org/jivesoftware/smackx/commands/RemoteCommand.java
index 3f5cb5ddc..37c9ce7ec 100755
--- a/source/org/jivesoftware/smackx/commands/RemoteCommand.java
+++ b/source/org/jivesoftware/smackx/commands/RemoteCommand.java
@@ -98,8 +98,7 @@ public class RemoteCommand extends AdHocCommand {
* in the Form. This form must be the anwser form of the previous stage. If
* there is a problem executing the command it throws an XMPPException.
*
- * @param response
- * the form anwser of the previous stage.
+ * @param form the form anwser of the previous stage.
* @throws XMPPException
*/
public void execute(Form form) throws XMPPException {
diff --git a/source/org/jivesoftware/smackx/packet/AdHocCommandData.java b/source/org/jivesoftware/smackx/packet/AdHocCommandData.java
index d5998a623..0b41019b8 100755
--- a/source/org/jivesoftware/smackx/packet/AdHocCommandData.java
+++ b/source/org/jivesoftware/smackx/packet/AdHocCommandData.java
@@ -132,7 +132,8 @@ public class AdHocCommandData extends IQ {
/**
* Returns the JID of the command host.
- * @return
+ *
+ * @return the JID of the command host.
*/
public String getId() {
return id;
@@ -144,7 +145,8 @@ public class AdHocCommandData extends IQ {
/**
* Returns the human name of the command
- * @return
+ *
+ * @return the name of the command.
*/
public String getName() {
return name;
@@ -156,7 +158,8 @@ public class AdHocCommandData extends IQ {
/**
* Returns the identifier of the command
- * @return
+ *
+ * @return the node.
*/
public String getNode() {
return node;
@@ -168,7 +171,8 @@ public class AdHocCommandData extends IQ {
/**
* Returns the list of notes that the command has.
- * @return
+ *
+ * @return the notes.
*/
public List