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/MCOIMAPNamespace.h | |
parent | 6fbe6f212003b97860a23c254e5124f0b2578366 (diff) |
Finished formatting docs for Appledoc for IMAP and SMTP
Diffstat (limited to 'src/objc/imap/MCOIMAPNamespace.h')
-rw-r--r-- | src/objc/imap/MCOIMAPNamespace.h | 29 |
1 files changed, 17 insertions, 12 deletions
diff --git a/src/objc/imap/MCOIMAPNamespace.h b/src/objc/imap/MCOIMAPNamespace.h index 392a3d1b..f3373c64 100644 --- a/src/objc/imap/MCOIMAPNamespace.h +++ b/src/objc/imap/MCOIMAPNamespace.h @@ -10,7 +10,7 @@ #define __MAILCORE_MCOIMAPNAMESPACE_H_ -// This class implements an IMAP namespace. +/** Represents an IMAP namespace */ #import <Foundation/Foundation.h> @@ -18,31 +18,36 @@ @interface MCOIMAPNamespace : NSObject <NSCopying> -// Returns a simple namespace with only an item. -// This item will have the given prefix and the given path delimiter. +/** + Returns a simple namespace with only one item. +*/ + (MCOIMAPNamespace *) namespaceWithPrefix:(NSString *)prefix delimiter:(char)delimiter; -// Returns the prefix of the main item of this namespace. +/** Returns the prefix of the main item of this namespace. */ - (NSString *) mainPrefix; -// Returns the path delimiter of the main item of this namespace. +/** Returns the path delimiter of the main item of this namespace */ - (char) mainDelimiter; -// Returns the list of prefixes of this namespace. +/** Returns the list of prefixes of this namespace. */ - (NSArray *) prefixes; -// Returns the folder path for the given list of path components in the context -// of the main item of the namespace. +/** + Returns the folder path for the given list of path components in the context + of the main item of the namespace. +*/ - (NSString *) pathForComponents:(NSArray *)components; -// Returns the folder path for the given list of path components and a prefix. -// It will use the best item matching the prefix to compute the path. +/** + Returns the folder path for the given list of path components and a prefix. + It will use the best item matching the prefix to compute the path. +*/ - (NSString *) pathForComponents:(NSArray *)components prefix:(NSString *)prefix; -// Returns the components given a folder path. +/** Returns the components given a folder path. */ - (NSArray *) componentsFromPath:(NSString *)path; -// Returns YES if the namespace contains the given folder path. +/** Returns YES if the namespace contains the given folder path. */ - (BOOL) containsFolderPath:(NSString *)path; @end |