aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/objc/imap/MCOIMAPPart.h
diff options
context:
space:
mode:
authorGravatar Matt Ronge <mronge@mronge.com>2013-06-02 20:41:28 -0500
committerGravatar Matt Ronge <mronge@mronge.com>2013-06-02 20:41:28 -0500
commit3ae5bf7a1d806c749c28f641be34733c85808efe (patch)
tree27513da58055e421686ace2601d37a1e23eacb28 /src/objc/imap/MCOIMAPPart.h
parent6fbe6f212003b97860a23c254e5124f0b2578366 (diff)
Finished formatting docs for Appledoc for IMAP and SMTP
Diffstat (limited to 'src/objc/imap/MCOIMAPPart.h')
-rw-r--r--src/objc/imap/MCOIMAPPart.h15
1 files changed, 9 insertions, 6 deletions
diff --git a/src/objc/imap/MCOIMAPPart.h b/src/objc/imap/MCOIMAPPart.h
index 58bdfd2d..029135bf 100644
--- a/src/objc/imap/MCOIMAPPart.h
+++ b/src/objc/imap/MCOIMAPPart.h
@@ -14,20 +14,23 @@
#import <MailCore/MCOConstants.h>
+/** Represents a single IMAP message part */
+
@interface MCOIMAPPart : MCOAbstractPart <NSCopying>
-// It's the part identifier.
-// A part identifier looks like 1.2.1
+/** A part identifier looks like 1.2.1 */
@property (nonatomic, copy) NSString * partID;
-// It's the size of the single part.
+/** The size of the single part in bytes */
@property (nonatomic, nonatomic) unsigned int size;
-// It's the encoding of the single part.
+/** It's the encoding of the single part */
@property (nonatomic, nonatomic) MCOEncoding encoding;
-// Returns the decoded size of the part.
-// For example, for a part that's encoded with base64, it will return actual_size * 3/4.
+/**
+ Returns the decoded size of the part.
+ For example, for a part that's encoded with base64, it will return actual_size * 3/4.
+*/
- (unsigned int) decodedSize;
@end