Javadoc updates.

git-svn-id: http://svn.igniterealtime.org/svn/repos/smack/trunk@3109 b35dd754-fafc-0310-a699-88a17e54d16e
This commit is contained in:
Matt Tucker 2005-11-19 18:13:50 +00:00 committed by matt
parent cd20108352
commit cc40bf4bcb
2 changed files with 7 additions and 6 deletions

View File

@ -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.
*/

View File

@ -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. <tt>jivesoftware.com</tt>.
* @param port the port on the server that should be used; e.g. <tt>5222</tt>.
* @throws XMPPException if an error occurs while trying to establish the connection.