1
0
Fork 0
mirror of https://github.com/vanitasvitae/Smack.git synced 2024-11-26 14:02:06 +01:00

Javadoc formatting.

git-svn-id: http://svn.igniterealtime.org/svn/repos/smack/trunk@10876 b35dd754-fafc-0310-a699-88a17e54d16e
This commit is contained in:
Matt Tucker 2008-11-13 18:31:37 +00:00 committed by matt
parent 5e559d0ee2
commit 8cd6f3ef1a

View file

@ -273,7 +273,7 @@ public class XMPPConnection {
* will be null. This value will be <tt>null</tt> if not connected to the server. * will be null. This value will be <tt>null</tt> if not connected to the server.
* *
* @return the ID of this connection returned from the XMPP server or <tt>null</tt> if * @return the ID of this connection returned from the XMPP server or <tt>null</tt> if
* not connected to the server. * not connected to the server.
*/ */
public String getConnectionID() { public String getConnectionID() {
if (!isConnected()) { if (!isConnected()) {
@ -342,7 +342,7 @@ public class XMPPConnection {
* For more advanced login settings see {@link ConnectionConfiguration}. * For more advanced login settings see {@link ConnectionConfiguration}.
* *
* @param username the username. * @param username the username.
* @param password the password or <tt>null</tt> if using a CallbackHandler. * @param password the password or <tt>null</tt> if using a CallbackHandler.
* @throws XMPPException if an error occurs. * @throws XMPPException if an error occurs.
*/ */
public void login(String username, String password) throws XMPPException { public void login(String username, String password) throws XMPPException {
@ -370,12 +370,12 @@ public class XMPPConnection {
* {@link ConnectionConfiguration#setCallbackHandler(javax.security.auth.callback.CallbackHandler)}. * {@link ConnectionConfiguration#setCallbackHandler(javax.security.auth.callback.CallbackHandler)}.
* For more advanced login settings see {@link ConnectionConfiguration}. * For more advanced login settings see {@link ConnectionConfiguration}.
* *
* @param username the username. * @param username the username.
* @param password the password or <tt>null</tt> if using a CallbackHandler. * @param password the password or <tt>null</tt> if using a CallbackHandler.
* @param resource the resource. * @param resource the resource.
* @throws XMPPException if an error occurs. * @throws XMPPException if an error occurs.
* @throws IllegalStateException if not connected to the server, or already logged in * @throws IllegalStateException if not connected to the server, or already logged in
* to the serrver. * to the serrver.
*/ */
public synchronized void login(String username, String password, String resource) throws XMPPException { public synchronized void login(String username, String password, String resource) throws XMPPException {
if (!isConnected()) { if (!isConnected()) {
@ -457,9 +457,9 @@ public class XMPPConnection {
* does succeed, your XMPP address will likely be in the form "server/123ABC" (where "123ABC" * does succeed, your XMPP address will likely be in the form "server/123ABC" (where "123ABC"
* is a random value generated by the server). * is a random value generated by the server).
* *
* @throws XMPPException if an error occurs or anonymous logins are not supported by the server. * @throws XMPPException if an error occurs or anonymous logins are not supported by the server.
* @throws IllegalStateException if not connected to the server, or already logged in * @throws IllegalStateException if not connected to the server, or already logged in
* to the serrver. * to the serrver.
*/ */
public synchronized void loginAnonymously() throws XMPPException { public synchronized void loginAnonymously() throws XMPPException {
if (!isConnected()) { if (!isConnected()) {
@ -1405,10 +1405,10 @@ public class XMPPConnection {
* occurs after an abrupt termination. * occurs after an abrupt termination.
* *
* @throws XMPPException if an error occurs while trying to establish the connection. * @throws XMPPException if an error occurs while trying to establish the connection.
* Two possible errors can occur which will be wrapped by an XMPPException -- * Two possible errors can occur which will be wrapped by an XMPPException --
* UnknownHostException (XMPP error code 504), and IOException (XMPP error code * UnknownHostException (XMPP error code 504), and IOException (XMPP error code
* 502). The error codes and wrapped exceptions can be used to present more * 502). The error codes and wrapped exceptions can be used to present more
* appropiate error messages to end-users. * appropiate error messages to end-users.
*/ */
public void connect() throws XMPPException { public void connect() throws XMPPException {
// Stablishes the connection, readers and writers // Stablishes the connection, readers and writers