mirror of
https://codeberg.org/Mercury-IM/Smack
synced 2024-11-26 16:22:06 +01:00
Javdoc fixes.
git-svn-id: http://svn.igniterealtime.org/svn/repos/smack/trunk@2243 b35dd754-fafc-0310-a699-88a17e54d16e
This commit is contained in:
parent
613f4b388b
commit
279aabc049
7 changed files with 13 additions and 11 deletions
|
@ -161,7 +161,7 @@ public class Chat {
|
||||||
* Sets whether only messages that have a matching threadID will be delivered to Chat instances.
|
* 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.
|
* 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) {
|
public static void setFilteredOnThreadID(boolean value) {
|
||||||
filteredOnThreadID = value;
|
filteredOnThreadID = value;
|
||||||
|
|
|
@ -164,7 +164,8 @@ public class Roster {
|
||||||
* The default subscription mode is {@link #SUBSCRIPTION_ACCEPT_ALL}.<p>
|
* The default subscription mode is {@link #SUBSCRIPTION_ACCEPT_ALL}.<p>
|
||||||
*
|
*
|
||||||
* If using the manual mode, a PacketListener should be registered that
|
* 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.
|
* @return the subscription mode.
|
||||||
*/
|
*/
|
||||||
|
@ -178,7 +179,8 @@ public class Roster {
|
||||||
* The default subscription mode is {@link #SUBSCRIPTION_ACCEPT_ALL}.<p>
|
* The default subscription mode is {@link #SUBSCRIPTION_ACCEPT_ALL}.<p>
|
||||||
*
|
*
|
||||||
* If using the manual mode, a PacketListener should be registered that
|
* 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.
|
* @param subscriptionMode the subscription mode.
|
||||||
*/
|
*/
|
||||||
|
@ -510,7 +512,7 @@ public class Roster {
|
||||||
* is unavailable (offline) or if no presence information is available, such as
|
* is unavailable (offline) or if no presence information is available, such as
|
||||||
* when you are not subscribed to the user's presence updates.
|
* 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 <tt>null</tt> if the user is unavailable
|
* @return the user's current presence, or <tt>null</tt> if the user is unavailable
|
||||||
* or if no presence information is available.
|
* or if no presence information is available.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -74,7 +74,7 @@ public class AndFilter implements PacketFilter {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates an empty AND filter. Filters should be added using the
|
* Creates an empty AND filter. Filters should be added using the
|
||||||
* {@link #addFilter(PacketFilter) method.
|
* {@link #addFilter(PacketFilter)} method.
|
||||||
*/
|
*/
|
||||||
public AndFilter() {
|
public AndFilter() {
|
||||||
size = 0;
|
size = 0;
|
||||||
|
|
|
@ -58,7 +58,7 @@ import org.jivesoftware.smack.packet.Packet;
|
||||||
/**
|
/**
|
||||||
* Filters for packets of a specific type of Message (e.g. CHAT).
|
* 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
|
* @author Ward Harold
|
||||||
*/
|
*/
|
||||||
public class MessageTypeFilter implements PacketFilter {
|
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.
|
* Creates a new message type filter using the specified message type.
|
||||||
*
|
*
|
||||||
* @param type
|
* @param type the message type.
|
||||||
*/
|
*/
|
||||||
public MessageTypeFilter(Message.Type type) {
|
public MessageTypeFilter(Message.Type type) {
|
||||||
this.type = type;
|
this.type = type;
|
||||||
|
|
|
@ -74,7 +74,7 @@ public class OrFilter implements PacketFilter {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates an empty OR filter. Filters should be added using the
|
* Creates an empty OR filter. Filters should be added using the
|
||||||
* {@link #addFilter(PacketFilter) method.
|
* {@link #addFilter(PacketFilter)} method.
|
||||||
*/
|
*/
|
||||||
public OrFilter() {
|
public OrFilter() {
|
||||||
size = 0;
|
size = 0;
|
||||||
|
|
|
@ -138,7 +138,7 @@ public class Authentication extends IQ {
|
||||||
*
|
*
|
||||||
* @param connectionID the connection ID.
|
* @param connectionID the connection ID.
|
||||||
* @param password the password.
|
* @param password the password.
|
||||||
* @see XMPPConnection#getConnectionID()
|
* @see org.jivesoftware.smack.XMPPConnection#getConnectionID()
|
||||||
*/
|
*/
|
||||||
public void setDigest(String connectionID, String password) {
|
public void setDigest(String connectionID, String password) {
|
||||||
this.digest = StringUtils.hash(connectionID + 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
|
* @param digest the digest, which is the SHA-1 hash of the connection ID
|
||||||
* the user's password, encoded as hex.
|
* the user's password, encoded as hex.
|
||||||
* @see XMPPConnection#getConnectionID()
|
* @see org.jivesoftware.smack.XMPPConnection#getConnectionID()
|
||||||
*/
|
*/
|
||||||
public void setDigest(String digest) {
|
public void setDigest(String digest) {
|
||||||
this.digest = digest;
|
this.digest = digest;
|
||||||
|
|
|
@ -237,7 +237,7 @@ public class DiscoverInfo extends IQ {
|
||||||
* Sets the entity's type. To get the official registry of values for the
|
* Sets the entity's type. To get the official registry of values for the
|
||||||
* 'type' attribute refer to <a href="http://www.jabber.org/registrar/disco-categories.html">Jabber::Registrar</a>
|
* 'type' attribute refer to <a href="http://www.jabber.org/registrar/disco-categories.html">Jabber::Registrar</a>
|
||||||
*
|
*
|
||||||
* @param name the identity's type.
|
* @param type the identity's type.
|
||||||
*/
|
*/
|
||||||
public void setType(String type) {
|
public void setType(String type) {
|
||||||
this.type = type;
|
this.type = type;
|
||||||
|
|
Loading…
Reference in a new issue