From cc40bf4bcb2f833714b6e16e987cebef9d3d6ab9 Mon Sep 17 00:00:00 2001 From: Matt Tucker Date: Sat, 19 Nov 2005 18:13:50 +0000 Subject: [PATCH] Javadoc updates. git-svn-id: http://svn.igniterealtime.org/svn/repos/smack/trunk@3109 b35dd754-fafc-0310-a699-88a17e54d16e --- source/org/jivesoftware/smack/RosterEntry.java | 8 +++++--- source/org/jivesoftware/smack/XMPPConnection.java | 5 ++--- 2 files changed, 7 insertions(+), 6 deletions(-) diff --git a/source/org/jivesoftware/smack/RosterEntry.java b/source/org/jivesoftware/smack/RosterEntry.java index 4b81a64ae..d61ad3814 100644 --- a/source/org/jivesoftware/smack/RosterEntry.java +++ b/source/org/jivesoftware/smack/RosterEntry.java @@ -125,7 +125,9 @@ public class RosterEntry { /** * Returns the roster subscription type of the entry. When the type is - * RosterPacket.ItemType.NONE, the subscription request is pending. + * {@link RosterPacket.ItemType#NONE} or {@link RosterPacket.ItemType#FROM}, + * refer to {@link RosterEntry getStatus()} to see if a subscription request + * is pending. * * @return the type. */ @@ -135,8 +137,8 @@ public class RosterEntry { /** * Returns the roster subscription status of the entry. When the status is - * RosterPacket.ItemStatus.SUBSCRIPTION_PENDING, the contact has to answer the subscription - * request. + * RosterPacket.ItemStatus.SUBSCRIPTION_PENDING, the contact has to answer the + * subscription request. * * @return the status. */ diff --git a/source/org/jivesoftware/smack/XMPPConnection.java b/source/org/jivesoftware/smack/XMPPConnection.java index ec29f30bf..cb5ac4977 100644 --- a/source/org/jivesoftware/smack/XMPPConnection.java +++ b/source/org/jivesoftware/smack/XMPPConnection.java @@ -168,9 +168,8 @@ public class XMPPConnection { } /** - * Creates a new connection to the specified XMPP server on the given port. The IP address - * of the server is assumed to match the service name. - * + * Creates a new connection to the XMPP server at the specifiec host and port. + * * @param host the name of the XMPP server to connect to; e.g. jivesoftware.com. * @param port the port on the server that should be used; e.g. 5222. * @throws XMPPException if an error occurs while trying to establish the connection.