1
0
Fork 0
mirror of https://codeberg.org/Mercury-IM/Smack synced 2025-09-10 18:59:41 +02:00

Fixed Javadoc warnings.

git-svn-id: http://svn.igniterealtime.org/svn/repos/smack/trunk@10858 b35dd754-fafc-0310-a699-88a17e54d16e
This commit is contained in:
Matt Tucker 2008-10-31 04:04:15 +00:00 committed by matt
parent bc82d8326f
commit b7e2c5b108
7 changed files with 39 additions and 32 deletions

View file

@ -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 the <code>getNotes</code> 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 {

View file

@ -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);

View file

@ -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 {