Skip to content
This repository
Browse code

Updated the inline API docs

  • Loading branch information...
commit c95e8fc48338d14e3439450e6191160dbbb6e3f0 1 parent a19d761
Matt Ronge authored
16  MailCore.xcodeproj/project.pbxproj
@@ -64,7 +64,6 @@
64 64
 		F8618D1C10DAE1E600C41188 /* (null) in Sources */ = {isa = PBXBuildFile; };
65 65
 		F8618D1D10DAE1E600C41188 /* CTBareAttachment.m in Sources */ = {isa = PBXBuildFile; fileRef = F81E26690C6ED35C00B3FBAC /* CTBareAttachment.m */; };
66 66
 		F8618D1E10DAE1E600C41188 /* MailCoreUtilities.m in Sources */ = {isa = PBXBuildFile; fileRef = F88804D60B4243C000D400E7 /* MailCoreUtilities.m */; };
67  
-		F8618D1F10DAE1EB00C41188 /* JRLog.m in Sources */ = {isa = PBXBuildFile; fileRef = F8A70EEE0C4059E100D1D694 /* JRLog.m */; };
68 67
 		F86B542314F476170080FB8F /* CTSMTPConnection.h in CopyFiles */ = {isa = PBXBuildFile; fileRef = F81B885A0A74AA7100143DF6 /* CTSMTPConnection.h */; };
69 68
 		F86B542414F4761C0080FB8F /* CTSMTPAsyncConnection.h in CopyFiles */ = {isa = PBXBuildFile; fileRef = 2D538B42119803A6000AB4A2 /* CTSMTPAsyncConnection.h */; };
70 69
 		F86B542514F4761E0080FB8F /* CTSMTP.h in CopyFiles */ = {isa = PBXBuildFile; fileRef = F88CA0CC0BF7A7B00055AC29 /* CTSMTP.h */; };
@@ -86,7 +85,6 @@
86 85
 		F86B543614F476500080FB8F /* MailCoreUtilities.h in CopyFiles */ = {isa = PBXBuildFile; fileRef = F88804D50B4243C000D400E7 /* MailCoreUtilities.h */; };
87 86
 		F86B543714F476530080FB8F /* MailCore.h in CopyFiles */ = {isa = PBXBuildFile; fileRef = F81B885C0A74AA7100143DF6 /* MailCore.h */; };
88 87
 		F86B543814F476540080FB8F /* MailCoreTypes.h in CopyFiles */ = {isa = PBXBuildFile; fileRef = F81B885D0A74AA7100143DF6 /* MailCoreTypes.h */; };
89  
-		F86B543914F476560080FB8F /* JRLog.h in CopyFiles */ = {isa = PBXBuildFile; fileRef = F8A70EED0C4059E100D1D694 /* JRLog.h */; };
90 88
 		F88804620B42018500D400E7 /* libsasl2.dylib in Frameworks */ = {isa = PBXBuildFile; fileRef = F88804610B42018500D400E7 /* libsasl2.dylib */; };
91 89
 		F88804D70B4243C000D400E7 /* MailCoreUtilities.h in Headers */ = {isa = PBXBuildFile; fileRef = F88804D50B4243C000D400E7 /* MailCoreUtilities.h */; settings = {ATTRIBUTES = (Public, ); }; };
92 90
 		F88804D80B4243C000D400E7 /* MailCoreUtilities.m in Sources */ = {isa = PBXBuildFile; fileRef = F88804D60B4243C000D400E7 /* MailCoreUtilities.m */; };
@@ -126,9 +124,6 @@
126 124
 		F8A2FAC4144FA87B00C03DB4 /* CTSMTPAsyncConnection.h in CopyFiles */ = {isa = PBXBuildFile; fileRef = 2D538B42119803A6000AB4A2 /* CTSMTPAsyncConnection.h */; };
127 125
 		F8A2FAC5144FA87D00C03DB4 /* CTSMTP.h in CopyFiles */ = {isa = PBXBuildFile; fileRef = F88CA0CC0BF7A7B00055AC29 /* CTSMTP.h */; };
128 126
 		F8A2FAC6144FA88100C03DB4 /* CTESMTP.h in CopyFiles */ = {isa = PBXBuildFile; fileRef = F88CA0D20BF7AC0B0055AC29 /* CTESMTP.h */; };
129  
-		F8A2FAC7144FA88F00C03DB4 /* JRLog.h in CopyFiles */ = {isa = PBXBuildFile; fileRef = F8A70EED0C4059E100D1D694 /* JRLog.h */; };
130  
-		F8A70EEF0C4059E100D1D694 /* JRLog.h in Headers */ = {isa = PBXBuildFile; fileRef = F8A70EED0C4059E100D1D694 /* JRLog.h */; settings = {ATTRIBUTES = (Public, ); }; };
131  
-		F8A70EF00C4059E100D1D694 /* JRLog.m in Sources */ = {isa = PBXBuildFile; fileRef = F8A70EEE0C4059E100D1D694 /* JRLog.m */; };
132 127
 		F8B245CE144BAC15002B56DA /* libetpan_ios.a in Frameworks */ = {isa = PBXBuildFile; fileRef = F8B245CA144BABA4002B56DA /* libetpan_ios.a */; };
133 128
 		F8B6D4F0156EE189008DE9EB /* libetpan_mac.a in Frameworks */ = {isa = PBXBuildFile; fileRef = F8B6D4EC156EE173008DE9EB /* libetpan_mac.a */; };
134 129
 		F8DFCF4C15801A5000C01975 /* SenTestingKit.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = F8DFCF4B15801A5000C01975 /* SenTestingKit.framework */; };
@@ -244,7 +239,6 @@
244 239
 			dstPath = "$(SRCROOT)/include/MailCore";
245 240
 			dstSubfolderSpec = 0;
246 241
 			files = (
247  
-				F86B543914F476560080FB8F /* JRLog.h in CopyFiles */,
248 242
 				F86B543814F476540080FB8F /* MailCoreTypes.h in CopyFiles */,
249 243
 				F86B543714F476530080FB8F /* MailCore.h in CopyFiles */,
250 244
 				F86B543614F476500080FB8F /* MailCoreUtilities.h in CopyFiles */,
@@ -276,7 +270,6 @@
276 270
 			dstSubfolderSpec = 0;
277 271
 			files = (
278 272
 				F8A2FAC3144FA87800C03DB4 /* CTSMTPConnection.h in CopyFiles */,
279  
-				F8A2FAC7144FA88F00C03DB4 /* JRLog.h in CopyFiles */,
280 273
 				F8A2FAC1144FA87300C03DB4 /* CTMIME.h in CopyFiles */,
281 274
 				F8A2FAC2144FA87400C03DB4 /* CTMIME_Enumerator.h in CopyFiles */,
282 275
 				F8A2FAC0144FA87100C03DB4 /* CTMIME_TextPart.h in CopyFiles */,
@@ -327,7 +320,7 @@
327 320
 		F81B88530A74AA7100143DF6 /* CTCoreAddress.m */ = {isa = PBXFileReference; fileEncoding = 30; lastKnownFileType = sourcecode.c.objc; name = CTCoreAddress.m; path = Source/CTCoreAddress.m; sourceTree = SOURCE_ROOT; };
328 321
 		F81B88540A74AA7100143DF6 /* CTCoreFolder.h */ = {isa = PBXFileReference; fileEncoding = 30; lastKnownFileType = sourcecode.c.h; name = CTCoreFolder.h; path = Source/CTCoreFolder.h; sourceTree = SOURCE_ROOT; };
329 322
 		F81B88550A74AA7100143DF6 /* CTCoreFolder.m */ = {isa = PBXFileReference; fileEncoding = 30; lastKnownFileType = sourcecode.c.objc; name = CTCoreFolder.m; path = Source/CTCoreFolder.m; sourceTree = SOURCE_ROOT; };
330  
-		F81B88560A74AA7100143DF6 /* CTCoreMessage.h */ = {isa = PBXFileReference; fileEncoding = 30; lastKnownFileType = sourcecode.c.h; name = CTCoreMessage.h; path = Source/CTCoreMessage.h; sourceTree = SOURCE_ROOT; };
  323
+		F81B88560A74AA7100143DF6 /* CTCoreMessage.h */ = {isa = PBXFileReference; fileEncoding = 30; lastKnownFileType = sourcecode.c.h; lineEnding = 0; name = CTCoreMessage.h; path = Source/CTCoreMessage.h; sourceTree = SOURCE_ROOT; xcLanguageSpecificationIdentifier = xcode.lang.objcpp; };
331 324
 		F81B88570A74AA7100143DF6 /* CTCoreMessage.m */ = {isa = PBXFileReference; fileEncoding = 30; lastKnownFileType = sourcecode.c.objc; name = CTCoreMessage.m; path = Source/CTCoreMessage.m; sourceTree = SOURCE_ROOT; };
332 325
 		F81B885A0A74AA7100143DF6 /* CTSMTPConnection.h */ = {isa = PBXFileReference; fileEncoding = 30; lastKnownFileType = sourcecode.c.h; name = CTSMTPConnection.h; path = Source/CTSMTPConnection.h; sourceTree = "<group>"; };
333 326
 		F81B885B0A74AA7100143DF6 /* CTSMTPConnection.m */ = {isa = PBXFileReference; fileEncoding = 30; lastKnownFileType = sourcecode.c.objc; name = CTSMTPConnection.m; path = Source/CTSMTPConnection.m; sourceTree = "<group>"; };
@@ -363,8 +356,6 @@
363 356
 		F88CA0D20BF7AC0B0055AC29 /* CTESMTP.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; name = CTESMTP.h; path = Source/CTESMTP.h; sourceTree = "<group>"; };
364 357
 		F88CA0D30BF7AC0B0055AC29 /* CTESMTP.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; name = CTESMTP.m; path = Source/CTESMTP.m; sourceTree = "<group>"; };
365 358
 		F890D38D10CEECD50039817C /* libetpan.xcodeproj */ = {isa = PBXFileReference; lastKnownFileType = "wrapper.pb-project"; name = libetpan.xcodeproj; path = "libetpan/build-mac/libetpan.xcodeproj"; sourceTree = SOURCE_ROOT; };
366  
-		F8A70EED0C4059E100D1D694 /* JRLog.h */ = {isa = PBXFileReference; fileEncoding = 30; lastKnownFileType = sourcecode.c.h; name = JRLog.h; path = Source/JRLog.h; sourceTree = "<group>"; };
367  
-		F8A70EEE0C4059E100D1D694 /* JRLog.m */ = {isa = PBXFileReference; fileEncoding = 30; lastKnownFileType = sourcecode.c.objc; name = JRLog.m; path = Source/JRLog.m; sourceTree = "<group>"; };
368 359
 		F8D31A3109C524EA00468234 /* main.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = main.m; sourceTree = "<group>"; };
369 360
 		F8DFAB0410541708003D3CC1 /* libetpan.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = libetpan.framework; path = "OpenSourceProjects/libetpan-0.58/build-mac/build/Release/libetpan.framework"; sourceTree = "<group>"; };
370 361
 		F8DFCF4915801A5000C01975 /* Tests.octest */ = {isa = PBXFileReference; explicitFileType = wrapper.cfbundle; includeInIndex = 0; path = Tests.octest; sourceTree = BUILT_PRODUCTS_DIR; };
@@ -527,8 +518,6 @@
527 518
 		32C88DFF0371C24200C91783 /* Other Sources */ = {
528 519
 			isa = PBXGroup;
529 520
 			children = (
530  
-				F8A70EED0C4059E100D1D694 /* JRLog.h */,
531  
-				F8A70EEE0C4059E100D1D694 /* JRLog.m */,
532 521
 				F81B88710A74AAD800143DF6 /* MailCore_Prefix.pch */,
533 522
 				F8D31A3109C524EA00468234 /* main.m */,
534 523
 			);
@@ -667,7 +656,6 @@
667 656
 				F81A8AE20C03FC3B002F780A /* CTMIME_TextPart.h in Headers */,
668 657
 				F81A8AE40C03FC3B002F780A /* CTMIME.h in Headers */,
669 658
 				F8245A6D0C041C8C005E08A8 /* CTMIMEFactory.h in Headers */,
670  
-				F8A70EEF0C4059E100D1D694 /* JRLog.h in Headers */,
671 659
 				F81E266A0C6ED35C00B3FBAC /* CTBareAttachment.h in Headers */,
672 660
 				F81E266E0C6ED4E100B3FBAC /* CTCoreAttachment.h in Headers */,
673 661
 				F8430BB10C72B16000753941 /* CTMIME_Enumerator.h in Headers */,
@@ -908,7 +896,6 @@
908 896
 				F81A8AE30C03FC3B002F780A /* CTMIME_TextPart.m in Sources */,
909 897
 				F81A8AE50C03FC3B002F780A /* CTMIME.m in Sources */,
910 898
 				F8245A700C041C91005E08A8 /* CTMIMEFactory.m in Sources */,
911  
-				F8A70EF00C4059E100D1D694 /* JRLog.m in Sources */,
912 899
 				F858CC4A0C51DE6B00EF1B3D /* (null) in Sources */,
913 900
 				F81E266B0C6ED35C00B3FBAC /* CTBareAttachment.m in Sources */,
914 901
 				F81E266F0C6ED4E100B3FBAC /* CTCoreAttachment.m in Sources */,
@@ -922,7 +909,6 @@
922 909
 			isa = PBXSourcesBuildPhase;
923 910
 			buildActionMask = 2147483647;
924 911
 			files = (
925  
-				F8618D1F10DAE1EB00C41188 /* JRLog.m in Sources */,
926 912
 				F8618D0D10DAE1E600C41188 /* CTSMTPConnection.m in Sources */,
927 913
 				F8618D0E10DAE1E600C41188 /* CTSMTP.m in Sources */,
928 914
 				F8618D0F10DAE1E600C41188 /* CTESMTP.m in Sources */,
12  Source/CTBareAttachment.h
@@ -34,7 +34,9 @@
34 34
 
35 35
 @class CTCoreAttachment;
36 36
 
37  
-//TODO Document me
  37
+/**
  38
+ Represents an attachment before it has been fully fetched.
  39
+*/
38 40
 @interface CTBareAttachment : NSObject {
39 41
     CTMIME_SinglePart *mMIMEPart;
40 42
     NSString *mFilename;
@@ -46,6 +48,14 @@
46 48
 
47 49
 -(NSString*)decodedFilename;
48 50
 - (id)initWithMIMESinglePart:(CTMIME_SinglePart *)part;
  51
+/**
  52
+ Fetches the full attachment
  53
+*/
49 54
 - (CTCoreAttachment *)fetchFullAttachment;
  55
+/**
  56
+ Fetches the full attachment
  57
+ 
  58
+ Also has a progress handler
  59
+*/
50 60
 - (CTCoreAttachment *)fetchFullAttachmentWithProgress:(CTProgressBlock)block;
51 61
 @end
93  Source/CTCoreAccount.h
@@ -32,12 +32,10 @@
32 32
 #import <Foundation/Foundation.h>
33 33
 #import <libetpan/libetpan.h>
34 34
 
35  
-/*!
36  
-    @class CTCoreAccount
37  
-    CTCoreAccount is the base class with which you establish a connection to the
38  
-    IMAP server. After establishing a connection with CTCoreAccount you can access
39  
-    all of the folders (I use the term folder instead of mailbox) on the server.
40  
-    All methods throw an exception on failure.
  35
+/**
  36
+ CTCoreAccount is the base class with which you establish a connection to the
  37
+ IMAP server. After establishing a connection with CTCoreAccount you can access
  38
+ all of the folders (I use the term folder instead of mailbox) on the server.
41 39
 */
42 40
 
43 41
 @class CTCoreFolder;
@@ -47,74 +45,73 @@
47 45
     BOOL connected;
48 46
     NSError *lastError;
49 47
 }
50  
-/*!
51  
-    @abstract If an error occurred (nil or return of NO) call this method to get the error
52  
- */
  48
+/**
  49
+ If an error occurred (nil or return of NO) call this method to get the error
  50
+*/
53 51
 @property(nonatomic, retain) NSError *lastError;
54 52
 
55  
-/*!
56  
-    @abstract	Retrieves the list of all the available folders from the server.
57  
-    @result		Returns a NSSet which contains NSStrings of the folders pathnames, nil on error
  53
+/**
  54
+ Retrieves the list of all the available folders from the server.
  55
+ @return Returns a NSSet which contains NSStrings of the folders pathnames, nil on error
58 56
 */
59 57
 - (NSSet *)allFolders;
60 58
 
61  
-/*!
62  
-    @abstract	Retrieves a list of only the subscribed folders from the server.
63  
-    @result		Returns a NSSet which contains NSStrings of the folders pathnames, nil on error
  59
+/**
  60
+ Retrieves a list of only the subscribed folders from the server.
  61
+ @return Returns a NSSet which contains NSStrings of the folders pathnames, nil on error
64 62
 */
65 63
 - (NSSet *)subscribedFolders;
66 64
 
67  
-/*!
68  
-    @abstract	If you have the path of a folder on the server use this method to retrieve just the one folder.
69  
-    @param		path A NSString specifying the path of the folder to retrieve from the server.
70  
-    @result		Returns a CTCoreFolder.
  65
+/**
  66
+ If you have the path of a folder on the server use this method to retrieve just the one folder.
  67
+ @param path A NSString specifying the path of the folder to retrieve from the server.
  68
+ @return Returns a CTCoreFolder.
71 69
 */
72 70
 - (CTCoreFolder *)folderWithPath:(NSString *)path;
73 71
 
74  
-/*!
75  
-    @abstract	This method initiates the connection to the server.
76  
-    @param		server The address of the server.
77  
-    @param		port The port to connect to.
78  
-    @param		connnectionType What kind of connection to use, it can be one of these three values:
79  
-                CTConnectionTypePlain, CTConnectionTypeStartTLS, CTConnectionTypeTryStartTLS, CTConnectionTypeTLS.
80  
-                See MailCoreTypes.h for more information
81  
-    @param		authType The authentication type, only CTImapAuthTypePlain is currently supported
82  
-    @param		login The username to connect with.
83  
-    @param		password The password to use to connect.
84  
-    @return     Return YES on success, NO on error. Call method lastError to get error if one occurred
  72
+/**
  73
+ This method initiates the connection to the server.
  74
+ @param server The address of the server.
  75
+ @param port The port to connect to.
  76
+ @param connnectionType What kind of connection to use, it can be one of these three values:
  77
+ CTConnectionTypePlain, CTConnectionTypeStartTLS, CTConnectionTypeTryStartTLS, CTConnectionTypeTLS. See MailCoreTypes.h for more information
  78
+ @param authType The authentication type, only CTImapAuthTypePlain is currently supported
  79
+ @param login The username to connect with.
  80
+ @param password The password to use to connect.
  81
+ @return Return YES on success, NO on error. Call method lastError to get error if one occurred
85 82
 */
86 83
 - (BOOL)connectToServer:(NSString *)server port:(int)port connectionType:(int)conType authType:(int)authType
87 84
                         login:(NSString *)login password:(NSString *)password;
88 85
 
89  
-/*!
90  
-    @abstract	This method returns the current connection status.
91  
-    @result		Returns YES or NO as the status of the connection.
  86
+/**
  87
+ This method returns the current connection status.
  88
+ @return Returns YES or NO as the status of the connection.
92 89
 */
93 90
 - (BOOL)isConnected;
94 91
 
95  
-/*!
96  
-    @abstract	Terminates the connection. If you terminate this connection it will also affect the
97  
-                connectivity of CTCoreFolders and CTMessages that rely on this account.
  92
+/**
  93
+ Terminates the connection. If you terminate this connection it will also affect the
  94
+ connectivity of CTCoreFolders and CTMessages that rely on this account.
98 95
 */
99 96
 - (void)disconnect;
100 97
 
101 98
 
102  
-/*!
103  
-    @abstract	Sends the idle command to the server.
104  
-    @return     Return YES on success, NO on error. Call method lastError to get error if one occurred
105  
- */
  99
+/**
  100
+ Sends the idle command to the server.
  101
+ @return Return YES on success, NO on error. Call method lastError to get error if one occurred
  102
+*/
106 103
 - (BOOL)idle;
107 104
 
108  
-/*!
109  
-    @abstract	Blocks the connection until data arrives.
110  
-    @return     Returns nil on error
111  
- */
  105
+/**
  106
+ Blocks the connection until data arrives.
  107
+ @return Returns nil on error
  108
+*/
112 109
 - (NSString *)read;
113 110
 
114  
-/*!
115  
-    @abstract	Sends the done command to the server.
116  
-    @return     Return YES on success, NO on error. Call method lastError to get error if one occurred
117  
- */
  111
+/**
  112
+ Sends the done command to the server.
  113
+ @return Return YES on success, NO on error. Call method lastError to get error if one occurred
  114
+*/
118 115
 - (BOOL)done;
119 116
 
120 117
 /* Intended for advanced use only */
45  Source/CTCoreAddress.h
@@ -31,60 +31,59 @@
31 31
 
32 32
 #import <Foundation/Foundation.h>
33 33
 
34  
-/*!
35  
-    @class	@CTCoreAddress
36  
-    This is a very simple class designed to make it easier to work with email addresses since many times
37  
-    the e-mail address and name are both encoded in the MIME e-mail fields. This class should be very straight
38  
-    forward, you can get and set a name and an e-mail address.
  34
+/**
  35
+ This is a very simple class designed to make it easier to work with email addresses since many times
  36
+ the e-mail address and name are both encoded in the MIME e-mail fields. This class should be very straight
  37
+ forward, you can get and set a name and an e-mail address.
39 38
 */
40 39
 
41 40
 @interface CTCoreAddress : NSObject {
42 41
     NSString *email;
43 42
     NSString *name;
44 43
 }
45  
-/*!
46  
-    @abstract Returns a CTCoreAddress with the name and e-mail address set as an empty string.
  44
+/**
  45
+ Returns a CTCoreAddress with the name and e-mail address set as an empty string.
47 46
 */
48 47
 + (id)address;
49 48
 
50  
-/*!
51  
-    @abstract Returns a CTCoreAddress set with the specified name and email.
  49
+/**
  50
+ Returns a CTCoreAddress set with the specified name and email.
52 51
 */
53 52
 + (id)addressWithName:(NSString *)aName email:(NSString *)aEmail;
54 53
 
55  
-/*!
56  
-    @abstract Returns a CTCoreAddress set with the specified name and email.
  54
+/**
  55
+ Returns a CTCoreAddress set with the specified name and email.
57 56
 */
58 57
 - (id)initWithName:(NSString *)aName email:(NSString *)aEmail;
59 58
 
60  
-/*!
61  
-    @abstract Returns the name as a NSString
  59
+/**
  60
+ Returns the name as a NSString
62 61
 */
63 62
 - (NSString *)name;
64 63
 -(NSString*)decodedName; // added by Gabor
65 64
 
66  
-/*!
67  
-    @abstract Sets the name.
  65
+/**
  66
+ Sets the name.
68 67
 */
69 68
 - (void)setName:(NSString *)aValue;
70 69
 
71  
-/*!
72  
-    @abstract Returns the e-mail as a NSString
  70
+/**
  71
+ Returns the e-mail as a NSString
73 72
 */
74 73
 - (NSString *)email;
75 74
 
76  
-/*!
77  
-    @abstract Sets the e-mail.
  75
+/**
  76
+ Sets the e-mail.
78 77
 */
79 78
 - (void)setEmail:(NSString *)aValue;
80 79
 
81  
-/*!
82  
-    @abstract Works like the typical isEqual: method
  80
+/**
  81
+ Works like the typical isEqual: method
83 82
 */
84 83
 - (BOOL)isEqual:(id)object;
85 84
 
86  
-/*!
87  
-    @abstract Standard description method
  85
+/**
  86
+ Standard description method
88 87
 */
89 88
 - (NSString *)description;
90 89
 @end
22  Source/CTCoreAttachment.h
@@ -32,13 +32,31 @@
32 32
 #import <Foundation/Foundation.h>
33 33
 #import "CTBareAttachment.h"
34 34
 
  35
+/**
  36
+  A message's attachment
  37
+*/
35 38
 @interface CTCoreAttachment : CTBareAttachment {
36 39
     NSData *mData;
37 40
 }
38 41
 @property(retain) NSData *data;
39 42
 
  43
+/**
  44
+ Load the attachment from a local file
  45
+ NOTE: This currently only works on Mac OS X, use initWithData:contentType:filename: instead on iOS
  46
+*/
  47
+
40 48
 - (id)initWithContentsOfFile:(NSString *)path;
41  
-- (id)initWithData:(NSData *)data contentType:(NSString *)contentType 
42  
-        filename:(NSString *)filename;
  49
+/**
  50
+ Create an attachment from a chunk of data
  51
+ 
  52
+ @param data The actual attachment data
  53
+ @param contentType The MIME content type you'd like to use
  54
+ @param filename The filename you'd like the attachment to be given in the e-mail message
  55
+*/
  56
+- (id)initWithData:(NSData *)data contentType:(NSString *)contentType filename:(NSString *)filename;
  57
+
  58
+/**
  59
+ Used to save the attachment locally
  60
+*/
43 61
 - (BOOL)writeToFile:(NSString *)path;
44 62
 @end
254  Source/CTCoreFolder.h
@@ -33,11 +33,10 @@
33 33
 #import <libetpan/libetpan.h>
34 34
 #import "MailCoreTypes.h"
35 35
 
36  
-/*!
37  
-    @class	CTCoreFolder
38  
-    CTCoreFolder is the class used to get and set attributes for a server side folder. It is also the
39  
-    class used to get a list of messages from the server. You need to make sure and establish a connection
40  
-    first by calling connect. All methods throw an exceptions on failure.
  36
+/**
  37
+ CTCoreFolder is the class used to get and set attributes for a server side folder. It is also the
  38
+ class used to get a list of messages from the server. You need to make sure and establish a connection
  39
+ first by calling connect.
41 40
 */
42 41
 
43 42
 @class CTCoreMessage, CTCoreAccount;
@@ -49,196 +48,201 @@
49 48
     BOOL connected;
50 49
     NSError *lastError;
51 50
 }
52  
-/*!
53  
-    @abstract If an error occurred (nil or return of NO) call this method to get the error
54  
- */
  51
+/**
  52
+ If an error occurred (nil or return of NO) call this method to get the error
  53
+*/
55 54
 @property(nonatomic, retain) NSError *lastError;
56 55
 
57  
-/*!
58  
-    @abstract	This method is used to initialize a folder. This method or the
59  
-                method in CTCoreAccount folderWithPath can be used to setup a folder.
60  
-    @param		inAccount This parameter must be passed in so the folder can initiate it's connection.
  56
+/**
  57
+ This method is used to initialize a folder. This method or the
  58
+ method in CTCoreAccount folderWithPath can be used to setup a folder.
  59
+ @param inAccount This parameter must be passed in so the folder can initiate it's connection.
61 60
 */
62 61
 - (id)initWithPath:(NSString *)path inAccount:(CTCoreAccount *)account;
63 62
 
64  
-/*!
65  
-    @abstract	This initiates the connection after the folder has been initalized.
66  
-    @return     Return YES on success, NO on error. Call method lastError to get error if one occurred
  63
+/**
  64
+ This initiates the connection after the folder has been initalized.
  65
+ @return Return YES on success, NO on error. Call method lastError to get error if one occurred
67 66
 */
68 67
 - (BOOL)connect;
69 68
 
70  
-/*!
71  
-    @abstract	This method terminates the connection, make sure you don't have any message
72  
-                connections open from this folder before disconnecting.
  69
+/**
  70
+ This method terminates the connection
  71
+ 
  72
+ Make sure you don't have any message connections open from this folder before disconnecting.
73 73
 */
74 74
 - (void)disconnect;
75 75
 
76  
-/*!
77  
-    @abstract	This will return the message from this folder with the UID that was passed in. If the message
78  
-                can't be found, nil is returned
79  
-    @result		A CTMessage object is returned which can be used to get further information and perform operations
80  
-                on the message.
  76
+/**
  77
+ This will return the message from this folder with the UID that was passed in.
  78
+
  79
+ A CTMessage object is returned which can be used to get further information and perform operationson the message.
  80
+ @return A CTCoreMessage or if not found, nil
81 81
 */
82 82
 - (CTCoreMessage *)messageWithUID:(NSUInteger)uid;
83 83
 
84  
-/*!
85  
-    @abstract   Use this method to download message lists from the server. This method take fetch attributes
86  
-                which configure what is fetched. Fetch attributes can be combined so you fetch all the message data at
87  
-                once, or select which pieces you want for your app. You can also fetch just the default attributes which
88  
-                will be as fast as possible.
89  
-    @param      start The message sequence number to start from, starts with 1 and NOT 0 (IMAP starts with 1 that way, sorry)
90  
-    @param      end The ending message sequence number, or if you'd like to fetch to the end of the message list pass in 0
91  
-    @param      attrs This controls what is fetched. Pass in CTFetchAttrDefaultsOnly to fetch the minimum possible, this
92  
-                includes the UID, RFC822.size, and flags. The defaults are always fetched, even when you don't pass in this flag.
93  
-                Use CTFetchAttrBodyStructure to also fetch the body structure of the message. This prevents a future round trip
94  
-                done by [CTCoreMessage fetchBodyStructure], if it sees you already have the body structure it won't re-fetch it.
95  
-                Use CTFetchAttrEnvelope if you'd like to fetch the subject, to, from, cc, bcc, sender, date etc. You can
96  
-                also fetch both the envelope and body structure by passing in CTFetchAttrEnvelope | CTFetchAttrBodyStructure
97  
-    @return     Returns a NSArray of CTCoreMessage's. Returns nil on error
  84
+/**
  85
+ Use this method to download message lists from the server.
  86
+ 
  87
+ This method take fetch attributes which configure what is fetched. Fetch attributes can be combined
  88
+ so you fetch all the message data at once, or select which pieces you want for your app. You can
  89
+ also fetch just the default attributes which will be as fast as possible. Pass in
  90
+ CTFetchAttrDefaultsOnly to attrs fetch the minimum possible, this includes the UID, RFC822.size, and
  91
+ flags. The defaults are always fetched, even when you don't pass in this flag.  Use
  92
+ CTFetchAttrBodyStructure to also fetch the body structure of the message. This prevents a future
  93
+ round trip done by [CTCoreMessage fetchBodyStructure], if it sees you already have the body
  94
+ structure it won't re-fetch it.  Use CTFetchAttrEnvelope if you'd like to fetch the subject, to,
  95
+ from, cc, bcc, sender, date etc. You can also fetch both the envelope and body structure by passing
  96
+ in CTFetchAttrEnvelope | CTFetchAttrBodyStructure
  97
+
  98
+ 
  99
+ @param start The message sequence number to start from, starts with 1 and NOT 0 (IMAP starts with 1 that way, sorry)
  100
+ @param end The ending message sequence number, or if you'd like to fetch to the end of the message list pass in 0
  101
+ @param attrs This controls what is fetched.
  102
+ @return Returns a NSArray of CTCoreMessage's. Returns nil on error
98 103
 */
99 104
 - (NSArray *)messagesFromSequenceNumber:(NSUInteger)startNum to:(NSUInteger)endNum withFetchAttributes:(CTFetchAttributes)attrs;
100 105
 
101  
-/*!
102  
-    @abstract   Use this method to download message lists from the server. This method uses UID ranges to determine
103  
-                which messages to download, while messagesFromSequenceNumber:to:withFetchAttributes: uses sequence numbers.
104  
-                This method take fetch attributes which configure what is fetched. Fetch attributes can be combined so
105  
-                you fetch all the message data at once, or select which pieces you want.
106  
-    @param      start The message sequence number to start from, starts with 1 and NOT 0 (IMAP starts with 1 that way, sorry)
107  
-    @param      end The ending message sequence number, or if you'd like to fetch to the end of the message list pass in 0
108  
-    @param      attrs This controls what is fetched. Pass in CTFetchAttrDefaultsOnly to fetch the minimum possible, this
109  
-                includes the UID, RFC822.size, and flags. The defaults are always fetched, even when you don't pass in this flag.
110  
-                Use CTFetchAttrBodyStructure to also fetch the body structure of the message. This prevents a future round trip
111  
-                done by [CTCoreMessage fetchBodyStructure], if it sees you already have the body structure it won't re-fetch it.
112  
-                Use CTFetchAttrEnvelope if you'd like to fetch the subject, to, from, cc, bcc, sender, date etc. You can
113  
-                also fetch both the envelope and body structure by passing in CTFetchAttrEnvelope | CTFetchAttrBodyStructure
114  
-    @return     Returns a NSArray of CTCoreMessage's. Returns nil on error
  106
+/**
  107
+ Use this method to download message lists from the server. 
  108
+ 
  109
+ This method uses UID ranges to determine which messages to download, while messagesFromSequenceNumber:to:withFetchAttributes: uses sequence numbers.
  110
+
  111
+ @param start The message sequence number to start from, starts with 1 and NOT 0 (IMAP starts with 1 that way, sorry)
  112
+ @param end The ending message sequence number, or if you'd like to fetch to the end of the message list pass in 0
  113
+ @param attrs This controls what is fetched.
  114
+ @return Returns a NSArray of CTCoreMessage's. Returns nil on error
  115
+ @see messagesFromSequenceNumber:to:withFetchAttributes:
115 116
 */
116 117
 - (NSArray *)messagesFromUID:(NSUInteger)startUID to:(NSUInteger)endUID withFetchAttributes:(CTFetchAttributes)attrs;
117 118
 
118  
-/*!
119  
-    @abstract	Pulls the sequence number for the message with the specified uid.
120  
-                It does not perform UID validation, and the sequence ID is only
121  
-                valid per session.
122  
-    @param		The uid for the message
123  
-    @return     Return YES on success, NO on error. Call method lastError to get error if one occurred
  119
+/**
  120
+ Pulls the sequence number for the message with the specified uid.
  121
+ It does not perform UID validation, and the sequence ID is only
  122
+ valid per session.
  123
+ @param The uid for the message
  124
+ @return Return YES on success, NO on error. Call method lastError to get error if one occurred
124 125
 */
125 126
 - (BOOL)sequenceNumberForUID:(NSUInteger)uid sequenceNumber:(NSUInteger *)sequenceNumber;
126 127
 
127 128
 
128  
-/*!
129  
-    @abstract   From IMAP RFC: "The CHECK command requests a checkpoint of the currently selected mailbox.
130  
-                A checkpoint refers to any implementation-dependent housekeeping associated
131  
-                with the mailbox (e.g., resolving the server's in-memory state of the mailbox
132  
-                with the state on its disk) that is not normally executed as part of each command."
133  
-    @return     Return YES on success, NO on error. Call method lastError to get error if one occurred
  129
+/**
  130
+ Perform an IMAP check command
  131
+ 
  132
+ From IMAP RFC: "The CHECK command requests a checkpoint of the currently selected mailbox.
  133
+ A checkpoint refers to any implementation-dependent housekeeping associated
  134
+ with the mailbox (e.g., resolving the server's in-memory state of the mailbox
  135
+ with the state on its disk) that is not normally executed as part of each command."
  136
+ @return Return YES on success, NO on error. Call method lastError to get error if one occurred
134 137
  */
135 138
 - (BOOL)check;
136 139
 
137  
-/*!
138  
-    @abstract	The folder name.
  140
+/**
  141
+ The folder name.
139 142
 */
140 143
 - (NSString *)name;
141 144
 
142  
-/*!
143  
-    @abstract	The entire path of folder.
  145
+/**
  146
+ The entire path of folder.
144 147
 */
145 148
 - (NSString *)path;
146 149
 
147  
-/*!
148  
-    @abstract	This will change the path of the folder. Use this method to rename the folder on the server
149  
-                or to move the folder on the server.
150  
-    @param		path The new path for the folder as an NSString.
151  
-    @return     Return YES on success, NO on error. Call method lastError to get error if one occurred
  150
+/**
  151
+ This will change the path of the folder.
  152
+ 
  153
+ Use this method to rename the folder on the server or to move the folder on the server.
  154
+ @param path The new path for the folder as an NSString.
  155
+ @return Return YES on success, NO on error. Call method lastError to get error if one occurred
152 156
 */
153 157
 - (BOOL)setPath:(NSString *)path;
154 158
 
155  
-/*!
156  
-    @abstract	If the folder doesn't exist on the server this method will create it. Make sure the pathname
157  
-                has been set first.
158  
-    @return     Return YES on success, NO on error. Call method lastError to get error if one occurred
  159
+/**
  160
+ If the folder doesn't exist on the server this method will create it. Make sure the pathname
  161
+ has been set first.
  162
+ @return Return YES on success, NO on error. Call method lastError to get error if one occurred
159 163
 */
160 164
 - (BOOL)create;
161 165
 
162  
-/*!
163  
-    @abstract	This method will remove the folder and any messages contained within from the server.
164  
-                Be careful when using this method because there is no way to undo.
165  
-    @return     Return YES on success, NO on error. Call method lastError to get error if one occurred
  166
+/**
  167
+ This method will remove the folder and any messages contained within from the server.
  168
+ Be careful when using this method because there is no way to undo.
  169
+ @return Return YES on success, NO on error. Call method lastError to get error if one occurred
166 170
 */
167 171
 - (BOOL)delete;
168 172
 
169  
-/*!
170  
-    @abstract	The folder will be listed as subscribed on the server.
171  
-    @return     Return YES on success, NO on error. Call method lastError to get error if one occurred
  173
+/**
  174
+ The folder will be listed as subscribed on the server.
  175
+ @return Return YES on success, NO on error. Call method lastError to get error if one occurred
172 176
 */
173 177
 - (BOOL)subscribe;
174 178
 
175  
-/*!
176  
-    @abstract	The folder will be listed as unsubscribed.
177  
-    @return     Return YES on success, NO on error. Call method lastError to get error if one occurred
  179
+/**
  180
+ The folder will be listed as unsubscribed.
  181
+ @return Return YES on success, NO on error. Call method lastError to get error if one occurred
178 182
 */
179 183
 - (BOOL)unsubscribe;
180 184
 
181  
-/*!
182  
-    @abstract	Retrieves the message flags. You must AND/OR using the defines constants.
183  
-                Here is a list of message flags:
184  
-                CTFlagNew, CTFlagSeen, CTFlagFlagged, CTFlagDeleted,
185  
-                CTFlagAnswered, CTFlagForwarded.
186  
-    @return     Return YES on success, NO on error. Call method lastError to get error if one occurred
  185
+/**
  186
+ Retrieves the message flags. You must AND/OR using the defines constants.
  187
+ Here is a list of message flags:
  188
+ CTFlagNew, CTFlagSeen, CTFlagFlagged, CTFlagDeleted,
  189
+ CTFlagAnswered, CTFlagForwarded.
  190
+ @return Return YES on success, NO on error. Call method lastError to get error if one occurred
187 191
 */
188 192
 - (BOOL)flagsForMessage:(CTCoreMessage *)msg flags:(NSUInteger *)flags;
189 193
 
190  
-/*!
191  
-    @abstract	Sets the message's flags on the server, take a look at the
192  
-                documentation for flagsForMessage:
193  
-    @return     Return YES on success, NO on error. Call method lastError to get error if one occurred
  194
+/**
  195
+ Sets the message's flags on the server, take a look at the
  196
+ documentation for flagsForMessage:
  197
+ @return Return YES on success, NO on error. Call method lastError to get error if one occurred
194 198
 */
195 199
 - (BOOL)setFlags:(NSUInteger)flags forMessage:(CTCoreMessage *)msg;
196 200
 
197  
-/*!
198  
-    @astract	Deletes all messages contained in the folder that are marked for
199  
-                deletion. Deleting messages in IMAP is a little strange, first
200  
-                you need to set the message flag CTFlagDeleted to CTFlagSet, and
201  
-                then when you call expunge on the folder the message is contained
202  
-                in, it will be deleted.
203  
-    @return     Return YES on success, NO on error. Call method lastError to get error if one occurred
  201
+/**
  202
+ Deletes all messages contained in the folder that are marked for
  203
+ deletion. Deleting messages in IMAP is a little strange, first
  204
+ you need to set the message flag CTFlagDeleted to CTFlagSet, and
  205
+ then when you call expunge on the folder the message is contained
  206
+ in, it will be deleted.
  207
+ @return Return YES on success, NO on error. Call method lastError to get error if one occurred
204 208
 */
205 209
 - (BOOL)expunge;
206 210
 
207  
-/*!
208  
-    @abstract	Copies a message to a folder
209  
-    @return     Return YES on success, NO on error. Call method lastError to get error if one occurred
210  
- */
  211
+/**
  212
+ Copies a message to a folder
  213
+ @return Return YES on success, NO on error. Call method lastError to get error if one occurred
  214
+*/
211 215
 - (BOOL)copyMessage:(CTCoreMessage *)msg toPath:(NSString *)path;
212 216
 
213  
-/*!
214  
-    @abstract	Moves a message to a folder
215  
-    @return     Return YES on success, NO on error. Call method lastError to get error if one occurred
216  
- */
  217
+/**
  218
+ Moves a message to a folder
  219
+ @return Return YES on success, NO on error. Call method lastError to get error if one occurred
  220
+*/
217 221
 - (BOOL)moveMessage:(CTCoreMessage *)msg toPath:(NSString *)path;
218 222
 
219  
-/*!
220  
-    @abstract	Returns the number of unread messages. This causes a round trip to the server, as it fetches
221  
-                the count for each call.
222  
-    @return     Return YES on success, NO on error. Call method lastError to get error if one occurred
  223
+/**
  224
+ Returns the number of unread messages. This causes a round trip to the server, as it fetches
  225
+ the count for each call.
  226
+ @return Return YES on success, NO on error. Call method lastError to get error if one occurred
223 227
 */
224 228
 - (BOOL)unreadMessageCount:(NSUInteger *)unseenCount;
225 229
 
226  
-/*!
227  
-    @abstract	Returns the number of messages in the folder. The count was retrieved when the folder connection was
228  
-                established, so to refresh the count you must disconnect and reconnect.
229  
-    @return     Return YES on success, NO on error. Call method lastError to get error if one occurred
  230
+/**
  231
+ Returns the number of messages in the folder. The count was retrieved when the folder connection was
  232
+ established, so to refresh the count you must disconnect and reconnect.
  233
+ @return Return YES on success, NO on error. Call method lastError to get error if one occurred
230 234
 */
231 235
 - (BOOL)totalMessageCount:(NSUInteger *)totalCount;
232 236
 
233  
-/*!
234  
-    @abstract	Returns the uid validity value for the folder, which can be used to determine if the
235  
-                local cached UID's are still valid, or if the server has changed UID's
  237
+/**
  238
+ Returns the uid validity value for the folder, which can be used to determine if the
  239
+ local cached UID's are still valid, or if the server has changed UID's
236 240
 */
237 241
 - (NSUInteger)uidValidity;
238 242
 
239  
-/*!
240  
-    @abstract	Returns the uid next value for the folder. The next message added to the mailbox
241  
-                will be assigned a UID greater than or equal to uidNext
  243
+/**
  244
+ Returns the uid next value for the folder. The next message added to the mailbox
  245
+ will be assigned a UID greater than or equal to uidNext
242 246
 */
243 247
 - (NSUInteger)uidNext;
244 248
 
269  Source/CTCoreMessage.h
@@ -32,13 +32,12 @@
32 32
 #import <Foundation/Foundation.h>
33 33
 #import <libetpan/libetpan.h>
34 34
 
35  
-/*!
36  
-    @class	CTCoreMessage
37  
-    CTCoreMessage is how you work with messages. The easiest way to instantiate a CTCoreMessage
38  
-    is to first setup a CTCoreAccount object and then get a CTCoreFolder object and then use it's
39  
-    convenience method messageWithUID: to get a message object you can work with.
  35
+/**
  36
+ CTCoreMessage is how you work with messages. The easiest way to instantiate a CTCoreMessage
  37
+ is to first setup a CTCoreAccount object and then get a CTCoreFolder object and then use it's
  38
+ convenience method messageWithUID: to get a message object you can work with.
40 39
 
41  
-    Anything that begins with "fetch", requires that an active network connection is present.
  40
+ Anything that begins with "fetch", requires that an active network connection is present.
42 41
 */
43 42
 
44 43
 @class CTCoreFolder, CTCoreAddress, CTCoreAttachment, CTMIME;
@@ -50,237 +49,265 @@
50 49
     NSUInteger mySequenceNumber;
51 50
     NSError *lastError;
52 51
 }
53  
-/*!
54  
-    @abstract If an error occurred (nil or return of NO) call this method to get the error
55  
- */
  52
+/**
  53
+ If an error occurred (nil or return of NO) call this method to get the error
  54
+*/
56 55
 @property(nonatomic, retain) NSError *lastError;
57 56
 
58  
-/*!
59  
-    @abstract   If the body structure has been fetched, this will contain the MIME structure
60  
- */
  57
+/**
  58
+ If the body structure has been fetched, this will contain the MIME structure
  59
+*/
61 60
 @property(retain) CTMIME *mime;
62 61
 
63  
-/*!
64  
-    @abstract	Used to instantiate an empty message object.
  62
+/**
  63
+ Used to instantiate an empty message object.
65 64
 */
66 65
 - (id)init;
67 66
 
68  
-/*!
69  
-    @abstract	Used to instantiate a message object with the contents of a mailmessage struct
70  
-                (a LibEtPan type). The mailmessage struct does not include any body information,
71  
-                so after calling this method the message will have a body which is NULL.
  67
+/**
  68
+ Used to instantiate a message object with the contents of a mailmessage struct
  69
+ (a LibEtPan type). The mailmessage struct does not include any body information,
  70
+ so after calling this method the message will have a body which is NULL.
72 71
 */
73 72
 - (id)initWithMessageStruct:(struct mailmessage *)message;
74 73
 
75  
-/*!
76  
-    @abstract	Used to instantiate a message object based off the contents of a file on disk.
77  
-                The file on disk must be a valid MIME message.
  74
+/**
  75
+ Used to instantiate a message object based off the contents of a file on disk.
  76
+ The file on disk must be a valid MIME message.
78 77
 */
79 78
 - (id)initWithFileAtPath:(NSString *)path;
80 79
 
81  
-/*!
82  
-    @abstract Used to instantiate a message object based off a string
83  
-                that contains a valid MIME message
  80
+/**
  81
+ Used to instantiate a message object based off a string
  82
+ that contains a valid MIME message
84 83
 */
85 84
 - (id)initWithString:(NSString *)msgData;
86 85
 
87 86
 /*
88  
-    @abstract	Creates an empty message
  87
+ Creates an empty message
89 88
 */
90 89
 - (id)init;
91 90
 
92  
-/*!
93  
-    @abstract   If a method returns nil or in the case of a BOOL returns NO, call this to get the error that occured
94  
- */
  91
+/**
  92
+ If a method returns nil or in the case of a BOOL returns NO, call this to get the error that occured
  93
+*/
95 94
 - (NSError *)lastError;
96 95
 
97  
-/*!
98  
-    @abstract   If the messages body structure hasn't been downloaded already it will be fetched from the server.
99  
-                The body structure is needed to get attachments or the message body
100  
-    @return     Return YES on success, NO on error. Call method lastError to get error if one occurred
101  
- */
  96
+/**
  97
+ If the messages body structure hasn't been downloaded already it will be fetched from the server.
  98
+
  99
+ The body structure is needed to get attachments or the message body
  100
+ @return Return YES on success, NO on error. Call method lastError to get error if one occurred
  101
+*/
102 102
 - (BOOL)fetchBodyStructure;
103 103
 
104  
-/*!
105  
-    @abstract	This method returns the parsed message body as an NSString.
106  
-                This attempts to return a plain text body and skips HTML. If
107  
-                a plaintext body isn't found the HTML body is returned.
  104
+/**
  105
+ This method returns the parsed message body as an NSString.
  106
+
  107
+ This attempts to return a plain text body and skips HTML. If
  108
+ a plaintext body isn't found the HTML body is returned.
108 109
 */
109 110
 - (NSString *)body;
110 111
 
111  
-/*!
112  
-    @abstract	This method returns the html body as an NSString.
113  
- */
  112
+/**
  113
+ This method returns the html body as an NSString.
  114
+*/
114 115
 - (NSString *)htmlBody;
115 116
 
116  
-/*!  @abstract Returns a message body as an NSString. First attempts
117  
-               to retrieve a plain text body, if that fails then
118  
-               tries for an HTML body.
119  
- */
  117
+/**  
  118
+ Returns a message body as an NSString. 
  119
+
  120
+ First attempts to retrieve a plain text body, if that fails then
  121
+ tries for an HTML body.
  122
+*/
120 123
 - (NSString *)bodyPreferringPlainText;
121 124
 
122  
-/*!
123  
-    @abstract	This method sets the message body. Plaintext only please!
  125
+/**
  126
+ This method sets the message body. Plaintext only please!
124 127
 */
125 128
 - (void)setBody:(NSString *)body;
126 129
 
127  
-/*!
128  
-    @abstract	Use this method to set the body if you have HTML content.
  130
+/**
  131
+ Use this method to set the body if you have HTML content.
129 132
 */
130 133
 - (void)setHTMLBody:(NSString *)body;
131 134
 
  135
+/**
  136
+ A list of attachments this message has
  137
+*/
132 138
 - (NSArray *)attachments;
  139
+
  140
+/**
  141
+ Add an attachment to the message.
  142
+ 
  143
+ Only used when sending e-mail
  144
+*/
133 145
 - (void)addAttachment:(CTCoreAttachment *)attachment;
134 146
 
135  
-/*!
136  
-    @abstract	Returns the subject of the message.
  147
+/**
  148
+ Returns the subject of the message.
137 149
 */
138 150
 - (NSString *)subject;
139 151
 
140  
-/*!
141  
-    @abstract	Will set the subject of the message, use this when composing e-mail.
  152
+/**
  153
+ Will set the subject of the message, use this when composing e-mail.
142 154
 */
143 155
 - (void)setSubject:(NSString *)subject;
144 156
 
145  
-/*! @abstract   Returns the timezone of the sender of the message (got from the Date field timezone attribute) */
  157
+/**
  158
+ Returns the timezone of the sender of the message (got from the Date field timezone attribute)
  159
+*/
146 160
 - (NSTimeZone*)senderTimeZone;
147 161
 
148  
-/*! @abstract   Returns the date as given in the Date mail field (no timezone is applied) */
  162
+/**
  163
+ Returns the date as given in the Date mail field (no timezone is applied)
  164
+*/
149 165
 - (NSDate *)senderDate; 
150 166
 
151  
-/*! @abstract   Returns the date in the Date field converted to GMT */
  167
+/**
  168
+ Returns the date in the Date field converted to GMT
  169
+*/
152 170
 - (NSDate *)sentDateGMT; 
153 171
 
154  
-/*!
155  
-    @abstract   Returns the date in the Date field converted to the local timezone
156  
-                the local timezone is the one set in the device running this code
157  
- */
  172
+/**
  173
+Returns the date in the Date field converted to the local timezone
  174
+    
  175
+The local timezone is the one set in the device running this code
  176
+*/
158 177
 - (NSDate *)sentDateLocalTimeZone; 
159 178
 
160  
-/*!
161  
-    @abstract	Returns YES if the message is unread.
162  
- */
  179
+/**
  180
+ Returns YES if the message is unread.
  181
+*/
163 182
 - (BOOL)isUnread;
164 183
 
165  
-/*!
166  
-    @abstract	Returns YES if the message is recent and unread.
  184
+/**
  185
+ Returns YES if the message is recent and unread.
167 186
 */
168 187
 - (BOOL)isNew;
169 188
 
170  
-/*!
171  
- @abstract	Returns YES if the message is starred (flagged in IMAP terms).
172  
- */
  189
+/**
  190
+ Returns YES if the message is starred (flagged in IMAP terms).
  191
+*/
173 192
 - (BOOL)isStarred;
174 193
 
175  
-/*!
176  
-    @abstract A machine readable ID that is guaranteed unique by the
177  
-    host that generated the message
  194
+/**
  195
+ A machine readable ID that is guaranteed unique by the
  196
+ host that generated the message
178 197
 */
179 198
 - (NSString *)messageId;
180 199
 
181  
-/*!
182  
-    @abstract	Returns an NSUInteger containing the messages UID. This number is unique across sessions
  200
+/**
  201
+ Returns an NSUInteger containing the messages UID. This number is unique across sessions
183 202
 */
184 203
 - (NSUInteger)uid;
185 204
 
186  
-/*!
187  
-    @abstract	Returns the message sequence number, this number cannot be used across sessions
  205
+/**
  206
+ Returns the message sequence number, this number cannot be used across sessions
188 207
 */
189 208
 - (NSUInteger)sequenceNumber;
190 209
 
191  
-/*!
192  
-    @abstract	Returns the message size in bytes
193  
- */
  210
+/**
  211
+ Returns the message size in bytes
  212
+*/
194 213
 - (NSUInteger)messageSize;
195 214
 
196  
-/*!
197  
-    @abstract   Returns the message flags. The flags contain if there user has replied, forwarded, read, delete etc.
198  
-                See MailCoreTypes.h for a list of constants
199  
- */
  215
+/**
  216
+ Returns the message flags.
  217
+ 
  218
+ The flags contain if there user has replied, forwarded, read, delete etc.
  219
+ See MailCoreTypes.h for a list of constants
  220
+*/
200 221
 - (NSUInteger)flags;
201 222
 
202  
-/*!
203  
-    @abstract	Set the message sequence number, this will NOT set any thing on the server.
204  
-                This is used to assign sequence numbers after retrieving the message list.
  223
+/**
  224
+ Set the message sequence number.
  225
+ 
  226
+ This will NOT set any thing on the server.
  227
+ This is used to assign sequence numbers after retrieving the message list.
205 228
 */
206 229
 - (void)setSequenceNumber:(NSUInteger)sequenceNumber;
207 230
 
208  
-/*!
209  
-    @abstract	Parses the from list, the result is an NSSet containing CTCoreAddress's
  231
+/**
  232
+ Parses the from list, the result is an NSSet containing CTCoreAddress's
210 233
 */
211 234
 - (NSSet *)from;
212 235
 
213  
-/*!
214  
-    @abstract	Sets the message's from addresses
215  
-    @param		addresses A NSSet containing CTCoreAddress's
  236
+/**
  237
+ Sets the message's from addresses
  238
+ @param addresses A NSSet containing CTCoreAddress's
216 239
 */
217 240
 - (void)setFrom:(NSSet *)addresses;
218 241
 
219  
-/*!
220  
-    @abstract	Returns the sender, which isn't always the actual person who sent the message, it's usually the
221  
-                address of the machine that sent the message. In reality, this method isn't very useful, use from: instead.
  242
+/**
  243
+ Returns the sender.
  244
+ 
  245
+ The sender which isn't always the actual person who sent the message, it's usually the
  246
+ address of the machine that sent the message. In reality, this method isn't very useful, use from: instead.
222 247
 */
223 248
 - (CTCoreAddress *)sender;
224 249
 
225  
-/*!
226  
-    @abstract	Returns the list of people the message was sent to, returns an NSSet containing CTAddress's.
  250
+/**
  251
+ Returns the list of people the message was sent to, returns an NSSet containing CTAddress's.
227 252
 */
228 253
 - (NSSet *)to;
229 254
 
230  
-/*!
231  
-    @abstract	Sets the message's to addresses
232  
-    @param		addresses A NSSet containing CTCoreAddress's
  255
+/**
  256
+ Sets the message's to addresses
  257
+ @param addresses A NSSet containing CTCoreAddress's
233 258
 */
234 259
 - (void)setTo:(NSSet *)addresses;
235 260
 
236  
-/*!
237  
-    @abstract	Returns the list of people the message was cced to, returns an NSSet containing CTAddress's.
  261
+/**
  262
+ Returns the list of people the message was cced to, returns an NSSet containing CTAddress's.
238 263
 */
239 264
 - (NSSet *)cc;
240 265
 
241  
-/*!
242  
-    @abstract	Sets the message's cc addresses
243  
-    @param		addresses A NSSet containing CTCoreAddress's
  266
+/**
  267
+ Sets the message's cc addresses
  268
+ @param addresses A NSSet containing CTCoreAddress's
244 269
 */
245 270
 - (void)setCc:(NSSet *)addresses;
246 271
 
247  
-/*!
248  
-    @abstract	Returns the list of people the message was bcced to, returns an NSSet containing CTAddress's.
  272
+/**
  273
+ Returns the list of people the message was bcced to, returns an NSSet containing CTAddress's.
249 274
 */
250 275
 - (NSSet *)bcc;
251 276
 
252  
-/*!
253  
-    @abstract	Sets the message's bcc addresses
254  
-    @param		addresses A NSSet containing CTCoreAddress's
  277
+/**
  278
+ Sets the message's bcc addresses
  279
+ @param addresses A NSSet containing CTCoreAddress's
255 280
 */
256 281
 - (void)setBcc:(NSSet *)addresses;
257 282
 
258  
-/*!
259  
-    @abstract	Returns the list of people the message was in reply-to, returns an NSSet containing CTAddress's.
  283
+/**
  284
+ Returns the list of people the message was in reply-to, returns an NSSet containing CTAddress's.
260 285
 */
261 286
 - (NSSet *)replyTo;
262 287
 
263  
-/*!
264  
-    @abstract	Sets the message's reply to addresses
265  
-    @param		addresses A NSSet containing CTCoreAddress's
  288
+/**
  289
+ Sets the message's reply to addresses
  290
+ @param addresses A NSSet containing CTCoreAddress's
266 291
 */
267 292
 - (void)setReplyTo:(NSSet *)addresses;
268 293
 
269  
-/*!
270  
-    @abstract	Returns the message rendered as the appropriate MIME and IMF content. Use this only if you
271  
-                want the raw encoding of the message.
  294
+/**
  295
+ Returns the message rendered as the appropriate MIME and IMF content.
  296
+ 
  297
+ Use this only if you want the raw encoding of the message.
272 298
 */
273 299
 - (NSString *)render;
274 300
 
275  
-/*!
276  
-    @abstract   Returns the message in the format Mail.app uses, Emlx. This format stores the message
277  
-                headers, body, and flags.
  301
+/**
  302
+ Returns the message in the format Mail.app uses, Emlx. 
  303
+ 
  304
+ This format stores the message headers, body, and flags.
278 305
 */
279 306
 - (NSData *)messageAsEmlx;
280 307
 
281  
-/*!
282  
-    @abstract   Fetches from the server the rfc822 content of the message, which is the headers and the message body.
283  
-    @return     Return nil on error. Call method lastError to get error if one occurred
  308
+/**
  309
+ Fetches from the server the rfc822 content of the message, which are the headers and the message body.
  310
+ @return Return nil on error. Call method lastError to get error if one occurred
284 311
 */
285 312
 - (NSString *)rfc822;
286 313
 
1  Source/CTCoreMessage.m
@@ -652,7 +652,6 @@ - (mailimap *)imapSession; {
652 652
     return data->imap_session;
653 653
 }
654 654
 
655  
-/*********************************** myprivates ***********************************/
656 655
 - (CTCoreAddress *)_addressFromMailbox:(struct mailimf_mailbox *)mailbox; {
657 656
     CTCoreAddress *address = [CTCoreAddress address];
658 657
     if (mailbox == NULL) {
7  Source/CTESMTP.h
@@ -32,10 +32,9 @@
32 32
 #import <Foundation/Foundation.h>
33 33
 #import "CTSMTP.h"
34 34
 
35  
-/*!
36  
-    @class	CTESMTP
37  
-    This class is used internally by CTSMTPConnection for ESMTP connections, clients
38  
-    should not use this directly.
  35
+/*
  36
+ This class is used internally by CTSMTPConnection for ESMTP connections, clients
  37
+ should not use this directly.
39 38
 */
40 39