diff options
author | 2013-06-02 20:41:28 -0500 | |
---|---|---|
committer | 2013-06-02 20:41:28 -0500 | |
commit | 3ae5bf7a1d806c749c28f641be34733c85808efe (patch) | |
tree | 27513da58055e421686ace2601d37a1e23eacb28 /src/objc/imap/MCOIMAPFolder.h | |
parent | 6fbe6f212003b97860a23c254e5124f0b2578366 (diff) |
Finished formatting docs for Appledoc for IMAP and SMTP
Diffstat (limited to 'src/objc/imap/MCOIMAPFolder.h')
-rw-r--r-- | src/objc/imap/MCOIMAPFolder.h | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/src/objc/imap/MCOIMAPFolder.h b/src/objc/imap/MCOIMAPFolder.h index 03858fc5..8688ef5b 100644 --- a/src/objc/imap/MCOIMAPFolder.h +++ b/src/objc/imap/MCOIMAPFolder.h @@ -10,20 +10,23 @@ #define __MAILCORE_MCOIMAPFOLDER_H_ -// This class implements an IMAP folder. +/** This class represents an IMAP folder */ #import <Foundation/Foundation.h> #import <MailCore/MCOConstants.h> @interface MCOIMAPFolder : NSObject <NSCopying> -// It's the path of the folder. +/** The folder's path, like for example INBOX.Archive */ @property (nonatomic, copy) NSString * path; -// It's the delimiter for each component of the path. +/** It's the delimiter for each component of the path. Commonly . or / */ @property (nonatomic, assign) char delimiter; -// It's the flags of the folder. See MCOIMAPFolderFlag. +/** + Any flags the folder may have, like if the folder is for Drafts, Spam, Junk, etc. Or + it could be marked with metadata like that it has no children. +*/ @property (nonatomic, assign) MCOIMAPFolderFlag flags; @end |