From 279aabc049d0037eeb84702c19a32faf4fb8c9c0 Mon Sep 17 00:00:00 2001 From: Matt Tucker Date: Thu, 11 Mar 2004 15:55:44 +0000 Subject: [PATCH] Javdoc fixes. git-svn-id: http://svn.igniterealtime.org/svn/repos/smack/trunk@2243 b35dd754-fafc-0310-a699-88a17e54d16e --- source/org/jivesoftware/smack/Chat.java | 2 +- source/org/jivesoftware/smack/Roster.java | 8 +++++--- source/org/jivesoftware/smack/filter/AndFilter.java | 2 +- .../org/jivesoftware/smack/filter/MessageTypeFilter.java | 4 ++-- source/org/jivesoftware/smack/filter/OrFilter.java | 2 +- source/org/jivesoftware/smack/packet/Authentication.java | 4 ++-- source/org/jivesoftware/smackx/packet/DiscoverInfo.java | 2 +- 7 files changed, 13 insertions(+), 11 deletions(-) diff --git a/source/org/jivesoftware/smack/Chat.java b/source/org/jivesoftware/smack/Chat.java index 3451f3ab8..e795d14f9 100644 --- a/source/org/jivesoftware/smack/Chat.java +++ b/source/org/jivesoftware/smack/Chat.java @@ -161,7 +161,7 @@ public class Chat { * Sets whether only messages that have a matching threadID will be delivered to Chat instances. * When false, any message from the other participant will be delivered to a Chat instances. * - * @value true if messages delivered to Chat instances are filtered on thread ID. + * @param value true if messages delivered to Chat instances are filtered on thread ID. */ public static void setFilteredOnThreadID(boolean value) { filteredOnThreadID = value; diff --git a/source/org/jivesoftware/smack/Roster.java b/source/org/jivesoftware/smack/Roster.java index f5ad60054..9166330d5 100644 --- a/source/org/jivesoftware/smack/Roster.java +++ b/source/org/jivesoftware/smack/Roster.java @@ -164,7 +164,8 @@ public class Roster { * The default subscription mode is {@link #SUBSCRIPTION_ACCEPT_ALL}.

* * If using the manual mode, a PacketListener should be registered that - * listens for Presence packets that have a type of {@link Presence.Type#SUBSCRIBE}. + * listens for Presence packets that have a type of + * {@link org.jivesoftware.smack.packet.Presence.Type#SUBSCRIBE}. * * @return the subscription mode. */ @@ -178,7 +179,8 @@ public class Roster { * The default subscription mode is {@link #SUBSCRIPTION_ACCEPT_ALL}.

* * If using the manual mode, a PacketListener should be registered that - * listens for Presence packets that have a type of {@link Presence.Type#SUBSCRIBE}. + * listens for Presence packets that have a type of + * {@link org.jivesoftware.smack.packet.Presence.Type#SUBSCRIBE}. * * @param subscriptionMode the subscription mode. */ @@ -510,7 +512,7 @@ public class Roster { * is unavailable (offline) or if no presence information is available, such as * when you are not subscribed to the user's presence updates. * - * @param user a fully qualified xmpp ID including a resource, e.g. jdoe@example.com/Home + * @param userResource a fully qualified xmpp ID including a resource, e.g. jdoe@example.com/Home * @return the user's current presence, or null if the user is unavailable * or if no presence information is available. */ diff --git a/source/org/jivesoftware/smack/filter/AndFilter.java b/source/org/jivesoftware/smack/filter/AndFilter.java index e860431e6..b330243aa 100644 --- a/source/org/jivesoftware/smack/filter/AndFilter.java +++ b/source/org/jivesoftware/smack/filter/AndFilter.java @@ -74,7 +74,7 @@ public class AndFilter implements PacketFilter { /** * Creates an empty AND filter. Filters should be added using the - * {@link #addFilter(PacketFilter) method. + * {@link #addFilter(PacketFilter)} method. */ public AndFilter() { size = 0; diff --git a/source/org/jivesoftware/smack/filter/MessageTypeFilter.java b/source/org/jivesoftware/smack/filter/MessageTypeFilter.java index 3dab851c6..211c5802d 100644 --- a/source/org/jivesoftware/smack/filter/MessageTypeFilter.java +++ b/source/org/jivesoftware/smack/filter/MessageTypeFilter.java @@ -58,7 +58,7 @@ import org.jivesoftware.smack.packet.Packet; /** * Filters for packets of a specific type of Message (e.g. CHAT). * - * @see Message.Type + * @see org.jivesoftware.smack.packet.Message.Type * @author Ward Harold */ public class MessageTypeFilter implements PacketFilter { @@ -68,7 +68,7 @@ public class MessageTypeFilter implements PacketFilter { /** * Creates a new message type filter using the specified message type. * - * @param type + * @param type the message type. */ public MessageTypeFilter(Message.Type type) { this.type = type; diff --git a/source/org/jivesoftware/smack/filter/OrFilter.java b/source/org/jivesoftware/smack/filter/OrFilter.java index f4a4b9932..ff609993b 100644 --- a/source/org/jivesoftware/smack/filter/OrFilter.java +++ b/source/org/jivesoftware/smack/filter/OrFilter.java @@ -74,7 +74,7 @@ public class OrFilter implements PacketFilter { /** * Creates an empty OR filter. Filters should be added using the - * {@link #addFilter(PacketFilter) method. + * {@link #addFilter(PacketFilter)} method. */ public OrFilter() { size = 0; diff --git a/source/org/jivesoftware/smack/packet/Authentication.java b/source/org/jivesoftware/smack/packet/Authentication.java index 63a7534d2..95fbb822e 100644 --- a/source/org/jivesoftware/smack/packet/Authentication.java +++ b/source/org/jivesoftware/smack/packet/Authentication.java @@ -138,7 +138,7 @@ public class Authentication extends IQ { * * @param connectionID the connection ID. * @param password the password. - * @see XMPPConnection#getConnectionID() + * @see org.jivesoftware.smack.XMPPConnection#getConnectionID() */ public void setDigest(String connectionID, String password) { this.digest = StringUtils.hash(connectionID + password); @@ -153,7 +153,7 @@ public class Authentication extends IQ { * * @param digest the digest, which is the SHA-1 hash of the connection ID * the user's password, encoded as hex. - * @see XMPPConnection#getConnectionID() + * @see org.jivesoftware.smack.XMPPConnection#getConnectionID() */ public void setDigest(String digest) { this.digest = digest; diff --git a/source/org/jivesoftware/smackx/packet/DiscoverInfo.java b/source/org/jivesoftware/smackx/packet/DiscoverInfo.java index 4735f229f..303bc5ff1 100644 --- a/source/org/jivesoftware/smackx/packet/DiscoverInfo.java +++ b/source/org/jivesoftware/smackx/packet/DiscoverInfo.java @@ -237,7 +237,7 @@ public class DiscoverInfo extends IQ { * Sets the entity's type. To get the official registry of values for the * 'type' attribute refer to Jabber::Registrar * - * @param name the identity's type. + * @param type the identity's type. */ public void setType(String type) { this.type = type;