Improved headers documentation. Fixed #109.

21 files changed, 66 insertions, 60 deletions

diff --git a/src/async/imap/MCIMAPFetchFoldersOperation.h b/src/async/imap/MCIMAPFetchFoldersOperation.h
index ebc49ca8..c59bf85a 100644
--- a/src/async/imap/MCIMAPFetchFoldersOperation.h
+++ b/src/async/imap/MCIMAPFetchFoldersOperation.h
@@ -32,7 +32,7 @@ namespace mailcore {
         virtual void main();
         
     private:
-        String * mFolder;
+        String * /* IMAPFolder */ mFolder;
         bool mFetchSubscribedEnabled;
         Array * mFolders;
         void setDelimiterDataOnMainThread(char * delimiterData);
diff --git a/src/async/imap/MCIMAPFetchMessagesOperation.h b/src/async/imap/MCIMAPFetchMessagesOperation.h
index c719ef6a..64f75bbf 100644
--- a/src/async/imap/MCIMAPFetchMessagesOperation.h
+++ b/src/async/imap/MCIMAPFetchMessagesOperation.h
@@ -44,7 +44,7 @@ namespace mailcore {
         bool mFetchByUidEnabled;
         IndexSet * mIndexes;
         IMAPMessagesRequestKind mKind;
-        Array * mMessages;
+        Array * /* IMAPMessage */ mMessages;
         IndexSet * mVanishedMessages;
         uint64_t mModSequenceValue;
         
diff --git a/src/async/imap/MCIMAPIdleOperation.h b/src/async/imap/MCIMAPIdleOperation.h
index de19469a..32ed0877 100644
--- a/src/async/imap/MCIMAPIdleOperation.h
+++ b/src/async/imap/MCIMAPIdleOperation.h
@@ -31,7 +31,7 @@ namespace mailcore {
         
     private:
         uint32_t mLastKnownUid;
-				bool mSetupSuccess;
+        bool mSetupSuccess;
         void prepare();
         void unprepare();
     };
diff --git a/src/async/imap/MCIMAPStoreLabelsOperation.h b/src/async/imap/MCIMAPStoreLabelsOperation.h
index fea31fd8..117a0a83 100644
--- a/src/async/imap/MCIMAPStoreLabelsOperation.h
+++ b/src/async/imap/MCIMAPStoreLabelsOperation.h
@@ -27,8 +27,8 @@ namespace mailcore {
         virtual void setKind(IMAPStoreFlagsRequestKind kind);
         virtual IMAPStoreFlagsRequestKind kind();
         
-        virtual void setLabels(Array * labels);
-        virtual Array * labels();
+        virtual void setLabels(Array * /* String */ labels);
+        virtual Array * /* String */ labels();
         
     public: // subclass behavior
         virtual void main();
@@ -36,7 +36,7 @@ namespace mailcore {
     private:
         IndexSet * mUids;
         IMAPStoreFlagsRequestKind mKind;
-        Array * mLabels;
+        Array * /* String */ mLabels;
         
     };
 }
diff --git a/src/async/pop/MCPOPFetchMessagesOperation.h b/src/async/pop/MCPOPFetchMessagesOperation.h
index e9d68014..74c97d4d 100644
--- a/src/async/pop/MCPOPFetchMessagesOperation.h
+++ b/src/async/pop/MCPOPFetchMessagesOperation.h
@@ -26,7 +26,7 @@ namespace mailcore {
         virtual void main();
         
     private:
-        Array * mMessages;
+        Array * /* POPMessageInfo */ mMessages;
     };
 }
 
diff --git a/src/core/abstract/MCAbstractMessage.h b/src/core/abstract/MCAbstractMessage.h
index 49c4805b..d7384b36 100644
--- a/src/core/abstract/MCAbstractMessage.h
+++ b/src/core/abstract/MCAbstractMessage.h
@@ -21,8 +21,8 @@ namespace mailcore {
         virtual AbstractPart * partForContentID(String * contentID);
         virtual AbstractPart * partForUniqueID(String * uniqueID);
         
-        virtual Array * attachments();
-        virtual Array * htmlInlineAttachments();
+        virtual Array * /* AbstractPart */ attachments();
+        virtual Array * /* AbstractPart */ htmlInlineAttachments();
         
     public: //subclass behavior
 		AbstractMessage(AbstractMessage * other);
diff --git a/src/core/abstract/MCMessageHeader.h b/src/core/abstract/MCMessageHeader.h
index 3e481db3..a29a6a3f 100644
--- a/src/core/abstract/MCMessageHeader.h
+++ b/src/core/abstract/MCMessageHeader.h
@@ -19,11 +19,11 @@ namespace mailcore {
 		virtual void setMessageID(String * messageID);
 		virtual String * messageID();
 		
-		virtual void setReferences(Array * references);
-		virtual Array * references();
+		virtual void setReferences(Array * /* String * references);
+		virtual Array * /* String */ references();
 		
-		virtual void setInReplyTo(Array * inReplyTo);
-		virtual Array * inReplyTo();
+		virtual void setInReplyTo(Array * /* String */ inReplyTo);
+		virtual Array * /* String */ inReplyTo();
 		
 		virtual void setDate(time_t date);
 		virtual time_t date();
@@ -37,17 +37,17 @@ namespace mailcore {
 		virtual void setFrom(Address * from);
 		virtual Address * from();
 		
-		virtual void setTo(Array * to);
-		virtual Array * to();
+		virtual void setTo(Array * /* Address */ to);
+		virtual Array * /* Address */ to();
 		
-		virtual void setCc(Array * cc);
-		virtual Array * cc();
+		virtual void setCc(Array * /* Address */ cc);
+		virtual Array * /* Address */ cc();
 		
-		virtual void setBcc(Array * bcc);
-		virtual Array * bcc();
+		virtual void setBcc(Array * /* Address */ bcc);
+		virtual Array * /* Address */ bcc();
 		
-		virtual void setReplyTo(Array * replyTo);
-		virtual Array * replyTo();
+		virtual void setReplyTo(Array * /* Address */ replyTo);
+		virtual Array * /* Address */ replyTo();
 		
 		virtual void setSubject(String * subject);
 		virtual String * subject();
diff --git a/src/core/imap/MCIMAPMessage.h b/src/core/imap/MCIMAPMessage.h
index 5bc5f843..5a9cadcb 100644
--- a/src/core/imap/MCIMAPMessage.h
+++ b/src/core/imap/MCIMAPMessage.h
@@ -35,8 +35,8 @@ namespace mailcore {
 		virtual void setMainPart(AbstractPart * mainPart);
 		virtual AbstractPart * mainPart();
 		
-		virtual void setGmailLabels(Array * labels);
-		virtual Array * gmailLabels();
+		virtual void setGmailLabels(Array * /* String */ labels);
+		virtual Array * /* String */ gmailLabels();
         
         virtual AbstractPart * partForPartID(String * partID);
         
@@ -58,7 +58,7 @@ namespace mailcore {
 		MessageFlag mFlags;
 		MessageFlag mOriginalFlags;
 		AbstractPart * mMainPart;
-		Array * mLabels;
+		Array * /* String */ mLabels;
 		void init();
 	};
 
diff --git a/src/core/imap/MCIMAPNamespace.h b/src/core/imap/MCIMAPNamespace.h
index 09c029e2..4ce0b546 100644
--- a/src/core/imap/MCIMAPNamespace.h
+++ b/src/core/imap/MCIMAPNamespace.h
@@ -18,12 +18,12 @@ namespace mailcore {
 		virtual String * mainPrefix();
 		virtual char mainDelimiter();
 
-		virtual Array * prefixes();
+		virtual Array * /* String */ prefixes();
 
 		virtual String * pathForComponents(Array * components);
 		virtual String * pathForComponentsAndPrefix(Array * components, String * prefix);
 
-		virtual Array * componentsFromPath(String * path);
+		virtual Array * /* String */ componentsFromPath(String * path);
 
 		virtual bool containsFolderPath(String * path);
 
@@ -35,7 +35,7 @@ namespace mailcore {
 		virtual Object * copy();
         
 	private:
-		Array * mItems;
+		Array * /* String */ mItems;
 		void init();
 		IMAPNamespaceItem * mainItem();
 		IMAPNamespaceItem * itemForPath(String * path);
diff --git a/src/core/imap/MCIMAPNamespaceItem.h b/src/core/imap/MCIMAPNamespaceItem.h
index 4cee0aea..8ab094cc 100644
--- a/src/core/imap/MCIMAPNamespaceItem.h
+++ b/src/core/imap/MCIMAPNamespaceItem.h
@@ -20,7 +20,7 @@ namespace mailcore {
 		virtual char delimiter();
 
 		virtual String * pathForComponents(Array * components);
-		virtual Array * componentsForPath(String * path);
+		virtual Array * /* String */ componentsForPath(String * path);
 
 		virtual bool containsFolder(String * folder);
         
diff --git a/src/core/provider/MCMailProvider.h b/src/core/provider/MCMailProvider.h
index 50f3deff..306b180d 100644
--- a/src/core/provider/MCMailProvider.h
+++ b/src/core/provider/MCMailProvider.h
@@ -26,9 +26,9 @@ namespace mailcore {
 		
 		virtual String * identifier();
 		
-		virtual Array * imapServices();
-		virtual Array * smtpServices();
-		virtual Array * popServices();
+		virtual Array * /* NetService */ imapServices();
+		virtual Array * /* NetService */ smtpServices();
+		virtual Array * /* NetService */ popServices();
 		
 		virtual bool matchEmail(String * email);
 		virtual bool matchMX(String * hostname);
@@ -53,12 +53,12 @@ namespace mailcore {
         
 	private:
 		String * mIdentifier;
-		Array * mDomainMatch;
-		Array * mImapServices;
-		Array * mSmtpServices;
-		Array * mPopServices;
+		Array * /* String */ mDomainMatch;
+		Array * /* NetService */ mImapServices;
+		Array * /* NetService */ mSmtpServices;
+		Array * /* NetService */ mPopServices;
 		HashMap * mMailboxPaths;
-		Set* mMxSet;
+		Set * mMxSet;
 		
 		void init();
     };
diff --git a/src/core/renderer/MCAddressDisplay.h b/src/core/renderer/MCAddressDisplay.h
index d84e55d0..3fe6856d 100644
--- a/src/core/renderer/MCAddressDisplay.h
+++ b/src/core/renderer/MCAddressDisplay.h
@@ -22,9 +22,9 @@ namespace mailcore {
         static String * shortDisplayStringForAddress(Address * address);
         static String * veryShortDisplayStringForAddress(Address * address);
         
-        static String * displayStringForAddresses(Array * addresses);
-        static String * shortDisplayStringForAddresses(Array * addresses);
-        static String * veryShortDisplayStringForAddresses(Array * addresses);
+        static String * displayStringForAddresses(Array * /* Address */ addresses);
+        static String * shortDisplayStringForAddresses(Array * /* Address */ addresses);
+        static String * veryShortDisplayStringForAddresses(Array * /* Address */ addresses);
     };
     
 };
diff --git a/src/core/renderer/MCHTMLRenderer.h b/src/core/renderer/MCHTMLRenderer.h
index 2a36a9f6..f76510e8 100644
--- a/src/core/renderer/MCHTMLRenderer.h
+++ b/src/core/renderer/MCHTMLRenderer.h
@@ -31,11 +31,11 @@ namespace mailcore {
                                            HTMLRendererIMAPCallback * dataCallback,
                                            HTMLRendererTemplateCallback * htmlCallback);
         
-        static Array * attachmentsForMessage(AbstractMessage * message);
-        static Array * htmlInlineAttachmentsForMessage(AbstractMessage * message);
+        static Array * /* AbstractPart */ attachmentsForMessage(AbstractMessage * message);
+        static Array * /* AbstractPart */ htmlInlineAttachmentsForMessage(AbstractMessage * message);
     };
 };
 
 #endif
 
-#endif /* defined(__testUI__MCHTMLRenderer__) */
+#endif
diff --git a/src/core/rfc822/MCMessageBuilder.h b/src/core/rfc822/MCMessageBuilder.h
index 63f325d3..409cd9ee 100644
--- a/src/core/rfc822/MCMessageBuilder.h
+++ b/src/core/rfc822/MCMessageBuilder.h
@@ -50,8 +50,8 @@ namespace mailcore {
 	private:
 		String * mHTMLBody;
 		String * mTextBody;
-		Array * mAttachments;
-		Array * mRelatedAttachments;
+		Array * /* Attachment */ mAttachments;
+		Array * /* Attachment */ mRelatedAttachments;
 		String * mBoundaryPrefix;
 		void init();
 		Data * dataAndFilterBcc(bool filterBcc);
diff --git a/src/core/smtp/MCSMTPSession.h b/src/core/smtp/MCSMTPSession.h
index dc949731..70237c16 100644
--- a/src/core/smtp/MCSMTPSession.h
+++ b/src/core/smtp/MCSMTPSession.h
@@ -82,7 +82,7 @@ namespace mailcore {
 		void loginIfNeeded(ErrorCode * pError);
 		bool checkCertificate();
 		
-		void sendMessage(Address * from, Array * recipients, Data * messageData,
+		void sendMessage(Address * from, Array * /* Address */ recipients, Data * messageData,
                          SMTPProgressCallback * callback, ErrorCode * pError);
 		void sendMessage(MessageBuilder * msg, SMTPProgressCallback * callback, ErrorCode * pError);
 	};
diff --git a/src/objc/abstract/MCOAbstractMessage.h b/src/objc/abstract/MCOAbstractMessage.h
index a26d5aac..bf442659 100644
--- a/src/objc/abstract/MCOAbstractMessage.h
+++ b/src/objc/abstract/MCOAbstractMessage.h
@@ -26,11 +26,17 @@
 /** Returns the part with the given unique identifier.*/
 - (MCOAbstractPart *) partForUniqueID:(NSString *)uniqueID;
 
-/** All attachments in the message */
-- (NSArray *) attachments;
-
-/** All HTML bodies */
-- (NSArray *) htmlInlineAttachments;
+/** All attachments in the message.
+ It will return an array of MCOIMAPPart for MCOIMAPMessage.
+ It will return an array of MCOAttachment for MCOMessageParser.
+ It will return an array of MCOAttachment for MCOMessageBuilder. */
+- (NSArray * /* MCOAbstractPart */) attachments;
+
+/** All image attachments included inline in the message through cid: URLs.
+ It will return an array of MCOIMAPPart for MCOIMAPMessage.
+ It will return an array of MCOAttachment for MCOMessageParser.
+ It will return an array of MCOAttachment for MCOMessageBuilder. */
+- (NSArray * /* MCOAbstractPart */) htmlInlineAttachments;
 
 @end
 
diff --git a/src/objc/imap/MCOIMAPMessage.h b/src/objc/imap/MCOIMAPMessage.h
index 81dfa9f7..c6d8595b 100644
--- a/src/objc/imap/MCOIMAPMessage.h
+++ b/src/objc/imap/MCOIMAPMessage.h
@@ -46,8 +46,8 @@
 /** Main MIME part of the message */
 @property (nonatomic, retain) MCOAbstractPart * mainPart;
 
-/** Any Gmail labels of the message */
-@property (nonatomic, copy) NSArray * gmailLabels;
+/** All Gmail labels of the message */
+@property (nonatomic, copy) NSArray * /* NSString */ gmailLabels;
 
 /**
  Returns the part with the given part identifier.
diff --git a/src/objc/imap/MCOIMAPNamespace.h b/src/objc/imap/MCOIMAPNamespace.h
index f3373c64..5fcda25b 100644
--- a/src/objc/imap/MCOIMAPNamespace.h
+++ b/src/objc/imap/MCOIMAPNamespace.h
@@ -30,7 +30,7 @@
 - (char) mainDelimiter;
 
 /** Returns the list of prefixes of this namespace. */
-- (NSArray *) prefixes;
+- (NSArray * /* NSString */) prefixes;
 
 /**
  Returns the folder path for the given list of path components in the context
@@ -45,7 +45,7 @@
 - (NSString *) pathForComponents:(NSArray *)components prefix:(NSString *)prefix;
 
 /** Returns the components given a folder path. */
-- (NSArray *) componentsFromPath:(NSString *)path;
+- (NSArray * /* NSString */) componentsFromPath:(NSString *)path;
 
 /** Returns YES if the namespace contains the given folder path. */
 - (BOOL) containsFolderPath:(NSString *)path;
diff --git a/src/objc/imap/MCOIMAPNamespaceItem.h b/src/objc/imap/MCOIMAPNamespaceItem.h
index b23d0dfc..3063919b 100644
--- a/src/objc/imap/MCOIMAPNamespaceItem.h
+++ b/src/objc/imap/MCOIMAPNamespaceItem.h
@@ -26,7 +26,7 @@
 - (NSString *) pathForComponents:(NSArray *)components;
 
 /** Returns components for the given path in the context of this namespace */
-- (NSArray *) componentsForPath:(NSString *)path;
+- (NSArray * /* NSString */) componentsForPath:(NSString *)path;
 
 /** Returns YES if the namespace contains this folder path */
 - (BOOL) containsFolder:(NSString *)folder;
diff --git a/src/objc/provider/MCOMailProvider.h b/src/objc/provider/MCOMailProvider.h
index 53f09736..85a23a8d 100644
--- a/src/objc/provider/MCOMailProvider.h
+++ b/src/objc/provider/MCOMailProvider.h
@@ -22,19 +22,19 @@
    A list of ways that you can connect to the IMAP server
    @return An array of MCONetService
 */
-- (NSArray *) imapServices;
+- (NSArray * /* MCONetService */) imapServices;
 
 /**
    A list of ways that you can connect to the SMTP server
    @return An array of MCONetService
 */
-- (NSArray *) smtpServices;
+- (NSArray * /* MCONetService */) smtpServices;
 
 /**
    A list of ways that you can connect to the POP3 server
    @return An array of MCONetService
 */
-- (NSArray *) popServices;
+- (NSArray * /* MCONetService */) popServices;
 
 - (BOOL) matchEmail:(NSString *)email;
 - (BOOL) matchMX:(NSString *)hostname;
diff --git a/src/objc/rfc822/MCOMessageBuilder.h b/src/objc/rfc822/MCOMessageBuilder.h
index 4fa78691..217ec49c 100644
--- a/src/objc/rfc822/MCOMessageBuilder.h
+++ b/src/objc/rfc822/MCOMessageBuilder.h
@@ -41,10 +41,10 @@
 @property (nonatomic, copy) NSString * textBody;
 
 /** List of file attachments.*/
-@property (nonatomic, copy) NSArray * attachments;
+@property (nonatomic, copy) NSArray * /* MCOAttachment */ attachments;
 
 /** List of related file attachments (included as cid: link in the HTML part).*/
-@property (nonatomic, copy) NSArray * relatedAttachments;
+@property (nonatomic, copy) NSArray * /* MCOAttachment */ relatedAttachments;
 
 /** Prefix for the boundary identifier. Default value is nil.*/
 @property (nonatomic, copy) NSString * boundaryPrefix;