diff options
author | Hoa V. DINH <dinh.viet.hoa@gmail.com> | 2015-01-20 23:45:47 -0800 |
---|---|---|
committer | Hoa V. DINH <dinh.viet.hoa@gmail.com> | 2015-01-20 23:45:47 -0800 |
commit | 14495bf6c1c20c0ac9f12b609fa5be849338d663 (patch) | |
tree | 717a218ed7e183e065bb0a2e741ebf029683e6fb | |
parent | e386f023d84b74eaeb3b8f2fa1c92bfe27df4f7e (diff) |
Fixed javadoc
27 files changed, 64 insertions, 58 deletions
diff --git a/src/java/com/libmailcore/AbstractMessage.java b/src/java/com/libmailcore/AbstractMessage.java index 7eb2a9af..3f76c695 100644 --- a/src/java/com/libmailcore/AbstractMessage.java +++ b/src/java/com/libmailcore/AbstractMessage.java @@ -4,16 +4,19 @@ import java.util.List; /** Abstract message. */ public class AbstractMessage extends NativeObject { - /** Header of the message. */ + /** Returns the header of the message. */ public native MessageHeader header(); /** Sets the header of the message. */ public native void setHeader(MessageHeader header); - /** Returns the MIME part with the given Content-ID. */ + /** + Returns the MIME part with the given Content-ID. + @see com.libmailcore.AbstractPart#contentID() + */ public native AbstractPart partForContentID(String contentID); /** Returns the MIME part with the given uniqueID. - @see AbtractPart#uniqueID() + @see com.libmailcore.AbstractPart#uniqueID() */ public native AbstractPart partForUniqueID(String uniqueID); /** Returns the list of attachments, not part of the content of the message. */ diff --git a/src/java/com/libmailcore/AbstractPart.java b/src/java/com/libmailcore/AbstractPart.java index 61ae15d2..60a325bc 100644 --- a/src/java/com/libmailcore/AbstractPart.java +++ b/src/java/com/libmailcore/AbstractPart.java @@ -6,12 +6,12 @@ import java.util.AbstractList; public class AbstractPart extends NativeObject { /** Returns the type of the part. - @see PartType. + @see com.libmailcore.PartType */ public native int partType(); /** Sets the type of the part. - @see PartType. + @see com.libmailcore.PartType */ public native void setPartType(int partType); @@ -53,11 +53,14 @@ public class AbstractPart extends NativeObject { /** Sets the hint about whether the attachment should be shown inline. */ public native void setInlineAttachment(boolean inlineAttachment); - /** Returns the MIME part with the given Content-ID. */ + /** + Returns the MIME part with the given Content-ID. + @see com.libmailcore.AbstractPart#contentID() + */ public native AbstractPart partForContentID(String contentID); /** Returns the MIME part with the given uniqueID. - @see AbtractPart#uniqueID() + @see com.libmailcore.AbstractPart#uniqueID() */ public native AbstractPart partForUniqueID(String uniqueID); diff --git a/src/java/com/libmailcore/Attachment.java b/src/java/com/libmailcore/Attachment.java index 91077ae0..1b40bc60 100644 --- a/src/java/com/libmailcore/Attachment.java +++ b/src/java/com/libmailcore/Attachment.java @@ -23,7 +23,7 @@ public class Attachment extends AbstractPart { /** Returns the content of the attachment decoded using the charset encoding. - @see AbstractPart#charset() + @see com.libmailcore.AbstractPart#charset() */ public native String decodedString(); }
\ No newline at end of file diff --git a/src/java/com/libmailcore/ConnectionLogType.java b/src/java/com/libmailcore/ConnectionLogType.java index b8001cdc..886b9903 100644 --- a/src/java/com/libmailcore/ConnectionLogType.java +++ b/src/java/com/libmailcore/ConnectionLogType.java @@ -1,7 +1,7 @@ package com.libmailcore; /** Logs type for the connection logger. - @see ConnectionLogger#log(long connectionID, int type, byte[] data) */ + @see com.libmailcore.ConnectionLogger#log(long connectionID, int type, byte[] data) */ public class ConnectionLogType { /** Received data. */ final public static int ConnectionLogTypeReceived = 0; diff --git a/src/java/com/libmailcore/ConnectionLogger.java b/src/java/com/libmailcore/ConnectionLogger.java index cb4973ca..81932935 100644 --- a/src/java/com/libmailcore/ConnectionLogger.java +++ b/src/java/com/libmailcore/ConnectionLogger.java @@ -4,8 +4,8 @@ package com.libmailcore; public interface ConnectionLogger { /** Called when a new connection logs is added. - @param param has one of the value of ConnectionLogType. - @see ConnectionLogType. + @param type has one of the value of ConnectionLogType. + @see com.libmailcore.ConnectionLogType */ void log(long connectionID, int type, byte[] data); } diff --git a/src/java/com/libmailcore/ErrorCode.java b/src/java/com/libmailcore/ErrorCode.java index bed7ed10..ec0833ab 100644 --- a/src/java/com/libmailcore/ErrorCode.java +++ b/src/java/com/libmailcore/ErrorCode.java @@ -1,7 +1,7 @@ package com.libmailcore; /** Error codes. - @see MailException#errorCode() */ + @see com.libmailcore.MailException#errorCode() */ public class ErrorCode { /** No error occurred.*/ public final static int ErrorNone = 0; // 0 diff --git a/src/java/com/libmailcore/HTMLRendererTemplateCallback.java b/src/java/com/libmailcore/HTMLRendererTemplateCallback.java index cda8f610..57caebb1 100644 --- a/src/java/com/libmailcore/HTMLRendererTemplateCallback.java +++ b/src/java/com/libmailcore/HTMLRendererTemplateCallback.java @@ -37,7 +37,7 @@ public interface HTMLRendererTemplateCallback { String templateForAttachmentSeparator(); /** Clean a HTML string. - The default implementation fixes broken tags, add missing <html>, <body> tags. + The default implementation fixes broken tags, add missing <html>, <body> tags. */ String cleanHTML(String html); /** diff --git a/src/java/com/libmailcore/IMAPCapabilityOperation.java b/src/java/com/libmailcore/IMAPCapabilityOperation.java index 63bc34f7..c3bb1712 100644 --- a/src/java/com/libmailcore/IMAPCapabilityOperation.java +++ b/src/java/com/libmailcore/IMAPCapabilityOperation.java @@ -3,6 +3,6 @@ package com.libmailcore; /** Operation to fetch the capabilities of the IMAP server. */ public class IMAPCapabilityOperation extends IMAPOperation { /** The result set will contains values of IMAPCabilityOperation. - @see IMAPCabilityOperation. */ + @see com.libmailcore.IMAPCapabilityOperation */ public native IndexSet capabilities(); } diff --git a/src/java/com/libmailcore/IMAPFolder.java b/src/java/com/libmailcore/IMAPFolder.java index 0128c4fb..e472167b 100644 --- a/src/java/com/libmailcore/IMAPFolder.java +++ b/src/java/com/libmailcore/IMAPFolder.java @@ -19,12 +19,12 @@ public class IMAPFolder extends NativeObject { /** Sets the flags of the folder. - @see IMAPFolderFlags + @see com.libmailcore.IMAPFolderFlags */ public native void setFlags(int flags); /** Returns the flags of the folder. - @see IMAPFolderFlags + @see com.libmailcore.IMAPFolderFlags */ public native int flags(); diff --git a/src/java/com/libmailcore/IMAPFolderFlags.java b/src/java/com/libmailcore/IMAPFolderFlags.java index 9d48a565..cb1743ce 100644 --- a/src/java/com/libmailcore/IMAPFolderFlags.java +++ b/src/java/com/libmailcore/IMAPFolderFlags.java @@ -1,7 +1,7 @@ package com.libmailcore; /** Flags of a folder. - @see IMAPFolder#flags() */ + @see com.libmailcore.IMAPFolder#flags() */ public class IMAPFolderFlags { public final static int IMAPFolderFlagNone = 0; public final static int IMAPFolderFlagMarked = 1 << 0; @@ -30,17 +30,17 @@ public class IMAPFolderFlags { public final static int IMAPFolderFlagArchive = 1 << 12; /** Same as IMAPFolderFlagAllMail. - @see IMAPFolderFlagAllMail + @see com.libmailcore.IMAPFolderFlags#IMAPFolderFlagAllMail */ public final static int IMAPFolderFlagAll = IMAPFolderFlagAllMail; /** Same as IMAPFolderFlagSpam. - @see IMAPFolderFlagSpam + @see com.libmailcore.IMAPFolderFlags#IMAPFolderFlagSpam */ public final static int IMAPFolderFlagJunk = IMAPFolderFlagSpam; /** Same as IMAPFolderFlagStarred. - @see IMAPFolderFlagStarred + @see com.libmailcore.IMAPFolderFlags#IMAPFolderFlagStarred */ public final static int IMAPFolderFlagFlagged = IMAPFolderFlagStarred; /** Mask for the types of folder. */ diff --git a/src/java/com/libmailcore/IMAPMessage.java b/src/java/com/libmailcore/IMAPMessage.java index 3745eab9..c6d638ec 100644 --- a/src/java/com/libmailcore/IMAPMessage.java +++ b/src/java/com/libmailcore/IMAPMessage.java @@ -21,23 +21,23 @@ public class IMAPMessage extends AbstractMessage { /** Sets flags of the message. - @see MessageFlag + @see com.libmailcore.MessageFlag */ public native void setFlags(int flags); /** Flags of the message. - @see MessageFlag + @see com.libmailcore.MessageFlag */ public native int flags(); /** Set original message flags. - @see MessageFlag + @see com.libmailcore.MessageFlag */ public native void setOriginalFlags(int flags); /** Original message flags. - @see MessageFlag + @see com.libmailcore.MessageFlag */ public native int originalFlags(); @@ -77,9 +77,9 @@ public class IMAPMessage extends AbstractMessage { /** Returns the MIME part with the given partID. - @see IMAPPart#partID() - @see IMAPMessagePart#partID() - @see IMAPMultipart#partID() + @see com.libmailcore.IMAPPart#partID() + @see com.libmailcore.IMAPMessagePart#partID() + @see com.libmailcore.IMAPMultipart#partID() */ public native AbstractPart partForPartID(String partID); diff --git a/src/java/com/libmailcore/IMAPMessagesRequestKind.java b/src/java/com/libmailcore/IMAPMessagesRequestKind.java index 106933aa..82199030 100644 --- a/src/java/com/libmailcore/IMAPMessagesRequestKind.java +++ b/src/java/com/libmailcore/IMAPMessagesRequestKind.java @@ -2,9 +2,9 @@ package com.libmailcore; /** Items to request when fetching the list of messages. - @see IMAPSession#fetchMessagesByUIDOperation(String folder, int requestKind, IndexSet indexes) - @see IMAPSession#fetchMessagesByNumberOperation(String folder, int requestKind, IndexSet indexes) - @see IMAPSession#syncMessagesByUIDOperation(String folder, int requestKind, IndexSet indexes, long modSeq) + @see com.libmailcore.IMAPSession#fetchMessagesByUIDOperation(String folder, int requestKind, IndexSet indexes) + @see com.libmailcore.IMAPSession#fetchMessagesByNumberOperation(String folder, int requestKind, IndexSet indexes) + @see com.libmailcore.IMAPSession#syncMessagesByUIDOperation(String folder, int requestKind, IndexSet indexes, long modSeq) */ public class IMAPMessagesRequestKind { /** Requests UID of the messages. */ @@ -29,7 +29,7 @@ public class IMAPMessagesRequestKind { public final static int IMAPMessagesRequestKindGmailThreadID = 1 << 8; /** Requests extra headers. - @see IMAPFetchMessagesOperation#setExtraHeaders(List<String> extraHeaders) + @see com.libmailcore.IMAPFetchMessagesOperation#setExtraHeaders */ public final static int IMAPMessagesRequestKindExtraHeaders = 1 << 9; /** Requests the size of the messages. */ diff --git a/src/java/com/libmailcore/IMAPOperation.java b/src/java/com/libmailcore/IMAPOperation.java index cf6d8ee4..22433066 100644 --- a/src/java/com/libmailcore/IMAPOperation.java +++ b/src/java/com/libmailcore/IMAPOperation.java @@ -18,7 +18,7 @@ public class IMAPOperation extends Operation { /** Calls the method succeeded() of the callback if the operation succeeded or failed() if the operation failed. - @see OperationCallback + @see com.libmailcore.OperationCallback */ protected void callCallback() { diff --git a/src/java/com/libmailcore/IMAPPart.java b/src/java/com/libmailcore/IMAPPart.java index 28ad7cda..50faf95c 100644 --- a/src/java/com/libmailcore/IMAPPart.java +++ b/src/java/com/libmailcore/IMAPPart.java @@ -17,12 +17,12 @@ public class IMAPPart extends AbstractPart { /** Sets encoding used (base64, quoted-printable, etc). - @see Encoding + @see com.libmailcore.Encoding */ public native void setEncoding(int encoding); /** Returns encoding used (base64, quoted-printable, etc.) - @see Encoding + @see com.libmailcore.Encoding */ public native int encoding(); diff --git a/src/java/com/libmailcore/IMAPSearchKind.java b/src/java/com/libmailcore/IMAPSearchKind.java index efbb0c9f..bbc8e7f8 100644 --- a/src/java/com/libmailcore/IMAPSearchKind.java +++ b/src/java/com/libmailcore/IMAPSearchKind.java @@ -1,7 +1,7 @@ package com.libmailcore; /** Search types. - @see IMAPSession#searchOperation(String folder, int kind, String searchString) */ + @see com.libmailcore.IMAPSession#searchOperation(String folder, int kind, String searchString) */ public class IMAPSearchKind { public final static int IMAPSearchKindAll = 0; public final static int IMAPSearchKindNone = 1; diff --git a/src/java/com/libmailcore/IMAPSession.java b/src/java/com/libmailcore/IMAPSession.java index eabcd63f..27ab8461 100644 --- a/src/java/com/libmailcore/IMAPSession.java +++ b/src/java/com/libmailcore/IMAPSession.java @@ -43,23 +43,23 @@ public class IMAPSession extends NativeObject { /** Sets the authentication type. - @see AuthType + @see com.libmailcore.AuthType */ public native void setAuthType(int authType); /** Returns authentication type. - @see Authtype + @see com.libmailcore.AuthType */ public native int authType(); /** Set connection type (clear-text, SSL or STARTTLS). - @see ConnectionType + @see com.libmailcore.ConnectionType */ public native void setConnectionType(int connectionType); /** Returns connection type (clear-text, SSL or STARTTLS). - @see ConnectionType + @see com.libmailcore.ConnectionType */ public native int connectionType(); diff --git a/src/java/com/libmailcore/IMAPStoreFlagsRequestKind.java b/src/java/com/libmailcore/IMAPStoreFlagsRequestKind.java index 7d6b65a6..6e826004 100644 --- a/src/java/com/libmailcore/IMAPStoreFlagsRequestKind.java +++ b/src/java/com/libmailcore/IMAPStoreFlagsRequestKind.java @@ -1,7 +1,7 @@ package com.libmailcore; /** Store request kind. - @see IMAPSession#storeFlagsByUIDOperation(String folder, IndexSet uids, int kind, int flags) */ + @see com.libmailcore.IMAPSession#storeFlagsByUIDOperation(String folder, IndexSet uids, int kind, int flags) */ public class IMAPStoreFlagsRequestKind { public final static int IMAPStoreFlagsRequestKindAdd = 0; public final static int IMAPStoreFlagsRequestKindRemove = 1; diff --git a/src/java/com/libmailcore/MailException.java b/src/java/com/libmailcore/MailException.java index 0d475b6e..0dd97967 100644 --- a/src/java/com/libmailcore/MailException.java +++ b/src/java/com/libmailcore/MailException.java @@ -3,7 +3,7 @@ package com.libmailcore; public class MailException extends Exception { /** Error code. - @see ErrorCode + @see com.libmailcore.ErrorCode */ public int errorCode() { diff --git a/src/java/com/libmailcore/MessageFlag.java b/src/java/com/libmailcore/MessageFlag.java index 888e44de..c06f1a76 100644 --- a/src/java/com/libmailcore/MessageFlag.java +++ b/src/java/com/libmailcore/MessageFlag.java @@ -1,7 +1,7 @@ package com.libmailcore; /** Flags of a message. - @see IMAPMessage#flags() */ + @see com.libmailcore.IMAPMessage#flags() */ public class MessageFlag { final public static int MessageFlagNone = 0; final public static int MessageFlagSeen = 1 << 0; diff --git a/src/java/com/libmailcore/NNTPOperation.java b/src/java/com/libmailcore/NNTPOperation.java index 243d3177..9c6a07aa 100644 --- a/src/java/com/libmailcore/NNTPOperation.java +++ b/src/java/com/libmailcore/NNTPOperation.java @@ -18,7 +18,7 @@ public class NNTPOperation extends Operation { /** Calls the method succeeded() of the callback if the operation succeeded or failed() if the operation failed. - @see OperationCallback + @see com.libmailcore.OperationCallback */ protected void callCallback() { diff --git a/src/java/com/libmailcore/NNTPSession.java b/src/java/com/libmailcore/NNTPSession.java index c54291b7..325a6b5a 100644 --- a/src/java/com/libmailcore/NNTPSession.java +++ b/src/java/com/libmailcore/NNTPSession.java @@ -34,12 +34,12 @@ public class NNTPSession extends NativeObject { /** Set connection type (clear-text, SSL or STARTTLS). - @see ConnectionType + @see com.libmailcore.ConnectionType */ public native void setConnectionType(int connectionType); /** Returns connection type (clear-text, SSL or STARTTLS). - @see ConnectionType + @see com.libmailcore.ConnectionType */ public native int connectionType(); diff --git a/src/java/com/libmailcore/Operation.java b/src/java/com/libmailcore/Operation.java index acc7e127..587a139e 100644 --- a/src/java/com/libmailcore/Operation.java +++ b/src/java/com/libmailcore/Operation.java @@ -6,8 +6,8 @@ public class Operation extends NativeObject { /** Returns whether the operation has been cancelled. */ public native boolean isCancelled(); - /** Starts the operation. Calls the aCallback.finished() when the operation is finished. - @see OperationCallback.finished() */ + /** Starts the operation. Calls the aCallback.succeeded() when the operation is finished. + @see com.libmailcore.OperationCallback#succeeded() */ public void start(OperationCallback aCallback) { callback = aCallback; diff --git a/src/java/com/libmailcore/POPOperation.java b/src/java/com/libmailcore/POPOperation.java index 5f8baed3..dd618703 100644 --- a/src/java/com/libmailcore/POPOperation.java +++ b/src/java/com/libmailcore/POPOperation.java @@ -18,7 +18,7 @@ public class POPOperation extends Operation { /** Calls the method succeeded() of the callback if the operation succeeded or failed() if the operation failed. - @see OperationCallback + @see com.libmailcore.OperationCallback */ protected void callCallback() { diff --git a/src/java/com/libmailcore/POPSession.java b/src/java/com/libmailcore/POPSession.java index 9feba046..16e5a531 100644 --- a/src/java/com/libmailcore/POPSession.java +++ b/src/java/com/libmailcore/POPSession.java @@ -34,23 +34,23 @@ public class POPSession extends NativeObject { /** Sets the authentication type. - @see AuthType + @see com.libmailcore.AuthType */ public native void setAuthType(int authType); /** Returns authentication type. - @see Authtype + @see com.libmailcore.AuthType */ public native int authType(); /** Set connection type (clear-text, SSL or STARTTLS). - @see ConnectionType + @see com.libmailcore.ConnectionType */ public native void setConnectionType(int connectionType); /** Returns connection type (clear-text, SSL or STARTTLS). - @see ConnectionType + @see com.libmailcore.ConnectionType */ public native int connectionType(); diff --git a/src/java/com/libmailcore/PartType.java b/src/java/com/libmailcore/PartType.java index eda8997a..3486551f 100644 --- a/src/java/com/libmailcore/PartType.java +++ b/src/java/com/libmailcore/PartType.java @@ -1,7 +1,7 @@ package com.libmailcore; /** MIME Part type. - @see AbstractPart#partType() */ + @see com.libmailcore.AbstractPart#partType() */ public class PartType { public final static int PartTypeSingle = 0; public final static int PartTypeMessage = 1; diff --git a/src/java/com/libmailcore/SMTPOperation.java b/src/java/com/libmailcore/SMTPOperation.java index a4c8f562..3eecb792 100644 --- a/src/java/com/libmailcore/SMTPOperation.java +++ b/src/java/com/libmailcore/SMTPOperation.java @@ -17,7 +17,7 @@ public class SMTPOperation extends Operation { /** Calls the method succeeded() of the callback if the operation succeeded or failed() if the operation failed. - @see OperationCallback + @see com.libmailcore.OperationCallback */ protected void callCallback() { diff --git a/src/java/com/libmailcore/SMTPSession.java b/src/java/com/libmailcore/SMTPSession.java index 36e00566..62a99245 100644 --- a/src/java/com/libmailcore/SMTPSession.java +++ b/src/java/com/libmailcore/SMTPSession.java @@ -41,23 +41,23 @@ public class SMTPSession extends NativeObject { /** Sets the authentication type. - @see AuthType + @see com.libmailcore.AuthType */ public native void setAuthType(int authType); /** Returns authentication type. - @see Authtype + @see com.libmailcore.AuthType */ public native int authType(); /** Set connection type (clear-text, SSL or STARTTLS). - @see ConnectionType + @see com.libmailcore.ConnectionType */ public native void setConnectionType(int connectionType); /** Returns connection type (clear-text, SSL or STARTTLS). - @see ConnectionType + @see com.libmailcore.ConnectionType */ public native int connectionType(); |