mirror of
https://codeberg.org/Mercury-IM/Smack
synced 2025-09-10 18:59:41 +02:00
Fix all javadoc warnings
This commit is contained in:
Florian Schmaus
parent
0058631ed6
commit
b8a5437b28
42 changed files with 137 additions and 205 deletions
|
|
@ -493,16 +493,6 @@ public class SASLAuthentication {
|
|||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Notification message saying that SASL authentication has failed. The server may have
|
||||
* closed the connection depending on the number of possible retries.
|
||||
*
|
||||
* @deprecated replaced by {@see #authenticationFailed(String)}.
|
||||
*/
|
||||
void authenticationFailed() {
|
||||
authenticationFailed(null);
|
||||
}
|
||||
|
||||
/**
|
||||
* Notification message saying that SASL authentication has failed. The server may have
|
||||
* closed the connection depending on the number of possible retries.
|
||||
|
|
|
|||
|
|
@ -176,7 +176,7 @@ public final class SmackConfiguration {
|
|||
* Sets the default max size of a packet collector before it will delete
|
||||
* the older packets.
|
||||
*
|
||||
* @param The number of packets to queue before deleting older packets.
|
||||
* @param collectorSize the number of packets to queue before deleting older packets.
|
||||
*/
|
||||
public static void setPacketCollectorSize(int collectorSize) {
|
||||
packetCollectorSize = collectorSize;
|
||||
|
|
|
|||
|
|
@ -844,7 +844,7 @@ public abstract class XMPPConnection {
|
|||
* XMPPConnection holds this information in order to avoid a dependency to
|
||||
* smackx where EntityCapsManager lives from smack.
|
||||
*
|
||||
* @return
|
||||
* @return the servers entity caps node
|
||||
*/
|
||||
public String getServiceCapsNode() {
|
||||
return serviceCapsNode;
|
||||
|
|
|
|||
|
|
@ -124,7 +124,7 @@ public abstract class IQ extends Packet {
|
|||
* <li>No child element of the IQ element.
|
||||
* </ul>
|
||||
*
|
||||
* @param iq the {@link Type#GET IQ.Type.GET} or {@link Type#SET IQ.Type.SET} IQ packet.
|
||||
* @param request the {@link Type#GET IQ.Type.GET} or {@link Type#SET IQ.Type.SET} IQ packet.
|
||||
* @throws IllegalArgumentException if the IQ packet does not have a type of
|
||||
* {@link Type#GET IQ.Type.GET} or {@link Type#SET IQ.Type.SET}.
|
||||
* @return a new {@link Type#RESULT IQ.Type.RESULT} IQ based on the originating IQ.
|
||||
|
|
@ -158,7 +158,7 @@ public abstract class IQ extends Packet {
|
|||
* <li>The provided {@link XMPPError XMPPError}.
|
||||
* </ul>
|
||||
*
|
||||
* @param iq the {@link Type#GET IQ.Type.GET} or {@link Type#SET IQ.Type.SET} IQ packet.
|
||||
* @param request the {@link Type#GET IQ.Type.GET} or {@link Type#SET IQ.Type.SET} IQ packet.
|
||||
* @param error the error to associate with the created IQ packet.
|
||||
* @throws IllegalArgumentException if the IQ packet does not have a type of
|
||||
* {@link Type#GET IQ.Type.GET} or {@link Type#SET IQ.Type.SET}.
|
||||
|
|
|
|||
|
|
@ -14,7 +14,6 @@
|
|||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.jivesoftware.smack.parsing;
|
||||
|
||||
/**
|
||||
|
|
@ -25,7 +24,7 @@ package org.jivesoftware.smack.parsing;
|
|||
*
|
||||
* Subclasses may or may not override certain methods of this class. Each of these methods will receive the exception
|
||||
* that caused the parsing error and an instance of an Unparsed Packet type. The latter can be used to inspect the
|
||||
* stanza that caused the parsing error by using the getContent() (for example {@link UnparsedIQ#getContent()})
|
||||
* stanza that caused the parsing error by using the getContent() (for example {@link UnparsablePacket#getContent()})
|
||||
* method.
|
||||
*
|
||||
* Smack provides 2 predefined ParsingExceptionCallback's: {@link ExceptionLoggingCallback} and {@link ExceptionThrowingCallback}.
|
||||
|
|
|
|||
|
|
@ -56,8 +56,8 @@ import org.xmlpull.v1.XmlPullParser;
|
|||
* </message>
|
||||
*
|
||||
* I would have a classes
|
||||
* {@link ItemsProvider} extends {@link EmbeddedExtensionProvider}
|
||||
* {@link ItemProvider} extends {@link EmbeddedExtensionProvider}
|
||||
* <tt>ItemsProvider</tt> extends {@link EmbeddedExtensionProvider}
|
||||
* <tt>ItemProvider</tt> extends {@link EmbeddedExtensionProvider}
|
||||
* and
|
||||
* AtomProvider extends {@link PacketExtensionProvider}
|
||||
*
|
||||
|
|
|
|||
|
|
@ -41,9 +41,9 @@ import javax.security.sasl.SaslException;
|
|||
* <li>{@link #getName()} -- returns the common name of the SASL mechanism.</li>
|
||||
* </ul>
|
||||
* Subclasses will likely want to implement their own versions of these methods:
|
||||
* <li>{@link #authenticate(String, String, String)} -- Initiate authentication stanza using the
|
||||
* <li>{@link #authenticate(String, String, String, String)} -- Initiate authentication stanza using the
|
||||
* deprecated method.</li>
|
||||
* <li>{@link #authenticate(String, String, CallbackHandler)} -- Initiate authentication stanza
|
||||
* <li>{@link #authenticate(String, CallbackHandler)} -- Initiate authentication stanza
|
||||
* using the CallbackHandler method.</li>
|
||||
* <li>{@link #challengeReceived(String)} -- Handle a challenge from the server.</li>
|
||||
* </ul>
|
||||
|
|
@ -87,7 +87,7 @@ public abstract class SASLMechanism implements CallbackHandler {
|
|||
/**
|
||||
* Builds and sends the <tt>auth</tt> stanza to the server. Note that this method of
|
||||
* authentication is not recommended, since it is very inflexable. Use
|
||||
* {@link #authenticate(String, String, CallbackHandler)} whenever possible.
|
||||
* {@link #authenticate(String, CallbackHandler)} whenever possible.
|
||||
*
|
||||
* Explanation of auth stanza:
|
||||
*
|
||||
|
|
|
|||
|
|
@ -55,7 +55,7 @@ public class DNSUtil {
|
|||
/**
|
||||
* Returns the current DNS resolved used to perform DNS lookups.
|
||||
*
|
||||
* @return
|
||||
* @return the active DNSResolver
|
||||
*/
|
||||
public static DNSResolver getDNSResolver() {
|
||||
return dnsResolver;
|
||||
|
|
@ -155,7 +155,7 @@ public class DNSUtil {
|
|||
* is calculated by random. The others are ore simply ordered by their priority.
|
||||
*
|
||||
* @param records
|
||||
* @return
|
||||
* @return the list of resolved HostAddresses
|
||||
*/
|
||||
protected static List<HostAddress> sortSRVRecords(List<SRVRecord> records) {
|
||||
// RFC 2782, Usage rules: "If there is precisely one SRV RR, and its Target is "."
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ public interface StringEncoder {
|
|||
* Encodes an string to another representation
|
||||
*
|
||||
* @param string
|
||||
* @return
|
||||
* @return the encoded String
|
||||
*/
|
||||
String encode(String string);
|
||||
|
||||
|
|
@ -32,7 +32,7 @@ public interface StringEncoder {
|
|||
* Decodes an string back to it's initial representation
|
||||
*
|
||||
* @param string
|
||||
* @return
|
||||
* @return the decoded String
|
||||
*/
|
||||
String decode(String string);
|
||||
}
|
||||
|
|
|
|||
|
|
@ -208,7 +208,7 @@ public class XmppDateTime {
|
|||
* does not.
|
||||
*
|
||||
* @param dateString
|
||||
* @return
|
||||
* @return the String with converted timezone
|
||||
*/
|
||||
public static String convertXep82TimezoneToRfc822(String dateString) {
|
||||
if (dateString.charAt(dateString.length() - 1) == 'Z') {
|
||||
|
|
@ -235,7 +235,7 @@ public class XmppDateTime {
|
|||
* Converts a time zone to the String format as specified in XEP-0082
|
||||
*
|
||||
* @param timeZone
|
||||
* @return
|
||||
* @return the String representation of the TimeZone
|
||||
*/
|
||||
public static String asString(TimeZone timeZone) {
|
||||
int rawOffset = timeZone.getRawOffset();
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
/**
|
||||
*
|
||||
* Copyright 2013 Florian Schmaus
|
||||
* Copyright 2013-2014 Florian Schmaus
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
|
|
@ -17,8 +17,8 @@
|
|||
package org.jivesoftware.smack.util.dns;
|
||||
|
||||
/**
|
||||
* @see <a href="http://tools.ietf.org/html/rfc2782>RFC 2782: A DNS RR for specifying the location of services (DNS
|
||||
* SRV)<a>
|
||||
* @see <a href="http://tools.ietf.org/html/rfc2782">RFC 2782: A DNS RR for specifying the location of services (DNS
|
||||
* SRV)</a>
|
||||
* @author Florian Schmaus
|
||||
*
|
||||
*/
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue