vanitasvitae/Smack
1
0
Fork 0
mirror of https://github.com/vanitasvitae/Smack.git synced 2024-11-23 04:22:05 +01:00
Code Issues Releases Wiki Activity

Fixed Javadoc warnings.

Browse source 
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
Show stats Download patch file Download diff file Expand all files Collapse all files

8
source/org/jivesoftware/smack/Roster.java
View file

@ -405,9 +405,11 @@ public class Roster {
* If the user has several presences (one for each resource), then the presence with * 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, * 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, * 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}, * that's {@link org.jivesoftware.smack.packet.Presence.Mode#chat free to chat},
* {@link Presence.Mode#away away}, {@link Presence.Mode#xa extended away}, and * {@link org.jivesoftware.smack.packet.Presence.Mode#available available},
* {@link Presence.Mode#dnd do not disturb}.<p> * {@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}.<p>
* <p/> * <p/>
* Note that presence information is received asynchronously. So, just after logging * 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 * in to the server, presence values for users in the roster may be unavailable

7
source/org/jivesoftware/smackx/PEPManager.java
View file

@ -70,7 +70,7 @@ public class PEPManager {
/** /**
* Creates a new PEP exchange manager. * Creates a new PEP exchange manager.
* *
* @param con an XMPPConnection. * @param connection an XMPPConnection.
*/ */
public PEPManager(XMPPConnection connection) { public PEPManager(XMPPConnection connection) {
this.connection = connection; this.connection = connection;
@ -94,7 +94,7 @@ public class PEPManager {
/** /**
* Removes a listener from PEP events. * Removes a listener from PEP events.
* *
* @param pepListener a roster exchange listener.. * @param pepListener a roster exchange listener.
*/ */
public void removePEPListener(PEPListener pepListener) { public void removePEPListener(PEPListener pepListener) {
synchronized (pepListeners) { synchronized (pepListeners) {
@ -105,8 +105,7 @@ public class PEPManager {
/** /**
* Publish an event. * Publish an event.
* *
* @param roster the roster to send * @param item the item to publish.
* @param targetUserID the user that will receive the roster entries
*/ */
public void publish(PEPItem item) { public void publish(PEPItem item) {
// Create a new message to publish the event. // Create a new message to publish the event.

18
source/org/jivesoftware/smackx/commands/AdHocCommand.java
View file

@ -108,7 +108,7 @@ public abstract class AdHocCommand {
* Set the the human readable name of the command, usually used for * Set the the human readable name of the command, usually used for
* displaying in a UI. * displaying in a UI.
* *
* @param name * @param name the name.
*/ */
public void setName(String name) { public void setName(String name) {
data.setName(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 * Gets the full JID of the owner of this command. This JID is the "to" of a
* execution request. * execution request.
* *
* @return * @return the owner JID.
*/ */
public abstract String getOwnerJID(); public abstract String getOwnerJID();
@ -167,7 +167,7 @@ public abstract class AdHocCommand {
* returned by the <code>getNotes</code> method during the current stage. * returned by the <code>getNotes</code> method during the current stage.
* Once the stage changes all the notes are discarded. * Once the stage changes all the notes are discarded.
* *
* @param note * @param note the note.
*/ */
protected void addNote(AdHocCommandNote note) { protected void addNote(AdHocCommandNote note) {
data.addNote(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 * Add an action to the current stage available actions. This should be used
* when creating a response. * when creating a response.
* *
* @param action * @param action the action.
*/ */
protected void addActionAvailable(Action action) { protected void addActionAvailable(Action action) {
data.addAction(action); data.addAction(action);
@ -307,7 +307,7 @@ public abstract class AdHocCommand {
* in the command then the action will be assumed "execute" thus assuming * in the command then the action will be assumed "execute" thus assuming
* the action returned by this method. * the action returned by this method.
* *
* @param action * @param action the action.
*/ */
protected void setExecuteAction(Action action) { protected void setExecuteAction(Action action) {
data.setExecuteAction(action); data.setExecuteAction(action);
@ -316,7 +316,7 @@ public abstract class AdHocCommand {
/** /**
* Returns the status of the current stage. * Returns the status of the current stage.
* *
* @return * @return the current status.
*/ */
public Status getStatus() { public Status getStatus() {
return data.getStatus(); return data.getStatus();
@ -325,7 +325,7 @@ public abstract class AdHocCommand {
/** /**
* Sets the data of the current stage. This should not used. * Sets the data of the current stage. This should not used.
* *
* @param data * @param data the data.
*/ */
void setData(AdHocCommandData data) { void setData(AdHocCommandData data) {
this.data = data; this.data = data;
@ -334,7 +334,7 @@ public abstract class AdHocCommand {
/** /**
* Gets the data of the current stage. This should not used. * Gets the data of the current stage. This should not used.
* *
* @param data * @return the data.
*/ */
AdHocCommandData getData() { AdHocCommandData getData() {
return data; return data;
@ -403,7 +403,7 @@ public abstract class AdHocCommand {
* The action is unknow. This is used when a recieved message has an * 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 action. It must not be used to send an execution request.
*/ */
unknown; unknown
} }
public enum SpecificErrorCondition { public enum SpecificErrorCondition {

8
source/org/jivesoftware/smackx/commands/LocalCommand.java
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 * Sets the JID of the command host. This is automatically handled and should
* not be called. * not be called.
* *
* @param ownerJID * @param ownerJID the JID of the owner.
*/ */
public void setOwnerJID(String ownerJID) { public void setOwnerJID(String ownerJID) {
this.ownerJID = 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 * Returns the time in milliseconds since this command was executed for
* first time. * first time.
* *
* @return * @return the time in milliseconds since the command was executed for the first time.
*/ */
public long getCreationStamp() { public long getCreationStamp() {
return creationStamp; return creationStamp;
@ -151,7 +151,7 @@ public abstract class LocalCommand extends AdHocCommand {
* Returns the currently executing stage number. The first stage number is * 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. * 0. So during the execution of the first action this method will answer 0.
* *
* @return * @return the current stage number.
*/ */
public int getCurrentStage() { public int getCurrentStage() {
return currenStage; 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 * all the stages of the command. It is not checked again during the
* execution. * execution.
* *
* @param jid * @param jid the JID to check permissions on.
* @return true if the user has permission to execute this action * @return true if the user has permission to execute this action
*/ */
public abstract boolean hasPermission(String jid); public abstract boolean hasPermission(String jid);

3
source/org/jivesoftware/smackx/commands/RemoteCommand.java
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 * 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. * there is a problem executing the command it throws an XMPPException.
* *
* @param response * @param form the form anwser of the previous stage.
* the form anwser of the previous stage.
* @throws XMPPException * @throws XMPPException
*/ */
public void execute(Form form) throws XMPPException { public void execute(Form form) throws XMPPException {

21
source/org/jivesoftware/smackx/packet/AdHocCommandData.java
View file

@ -132,7 +132,8 @@ public class AdHocCommandData extends IQ {
/** /**
* Returns the JID of the command host. * Returns the JID of the command host.
* @return *
* @return the JID of the command host.
*/ */
public String getId() { public String getId() {
return id; return id;
@ -144,7 +145,8 @@ public class AdHocCommandData extends IQ {
/** /**
* Returns the human name of the command * Returns the human name of the command
* @return *
* @return the name of the command.
*/ */
public String getName() { public String getName() {
return name; return name;
@ -156,7 +158,8 @@ public class AdHocCommandData extends IQ {
/** /**
* Returns the identifier of the command * Returns the identifier of the command
* @return *
* @return the node.
*/ */
public String getNode() { public String getNode() {
return node; return node;
@ -168,7 +171,8 @@ public class AdHocCommandData extends IQ {
/** /**
* Returns the list of notes that the command has. * Returns the list of notes that the command has.
* @return *
* @return the notes.
*/ */
public List<AdHocCommandNote> getNotes() { public List<AdHocCommandNote> getNotes() {
return notes; return notes;
@ -184,7 +188,8 @@ public class AdHocCommandData extends IQ {
/** /**
* Returns the form of the command. * Returns the form of the command.
* @return *
* @return the data form associated with the command.
*/ */
public DataForm getForm() { public DataForm getForm() {
return form; return form;
@ -196,7 +201,8 @@ public class AdHocCommandData extends IQ {
/** /**
* Returns the action to execute. The action is set only on a request. * Returns the action to execute. The action is set only on a request.
* @return *
* @return the action to execute.
*/ */
public AdHocCommand.Action getAction() { public AdHocCommand.Action getAction() {
return action; return action;
@ -208,7 +214,8 @@ public class AdHocCommandData extends IQ {
/** /**
* Returns the status of the execution. * Returns the status of the execution.
* @return *
* @return the status.
*/ */
public AdHocCommand.Status getStatus() { public AdHocCommand.Status getStatus() {
return status; return status;

2
source/org/jivesoftware/smackx/provider/VCardProvider.java
View file

@ -86,7 +86,7 @@ public class VCardProvider implements IQProvider {
* *
* @param xml the xml representing a users vCard. * @param xml the xml representing a users vCard.
* @return the VCard. * @return the VCard.
* @throws * @throws Exception if an exception occurs.
*/ */
public static VCard createVCardFromXML(String xml) throws Exception { public static VCard createVCardFromXML(String xml) throws Exception {
VCard vCard = new VCard(); VCard vCard = new VCard();