From a74e8ad4b7ab8a2ca886b8b0a473f6a4c6e8fe1b Mon Sep 17 00:00:00 2001 From: CaS Date: Wed, 12 Feb 2003 09:32:19 +0000 Subject: [PATCH] Improve comments. git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@15949 72102866-910b-0410-8b05-ffd578937521 --- Source/Additions/GSMime.m | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/Source/Additions/GSMime.m b/Source/Additions/GSMime.m index 1d83d856c..0fac4ac28 100644 --- a/Source/Additions/GSMime.m +++ b/Source/Additions/GSMime.m @@ -3373,8 +3373,8 @@ static NSCharacterSet *tokenSet = nil; } /** - * This returns the content data of the document in the - * appropriate format for the type of data - + * This returns the content data of the document in the same format in + * which the data was placed in the document. This may be one of - * * text * an NSString object @@ -3383,6 +3383,8 @@ static NSCharacterSet *tokenSet = nil; * multipart * an NSArray object containing GSMimeDocument objects * + * If you want to be sure that you get a particular type of data, use the + * -convertToData or -convertToText method. */ - (id) content { @@ -3556,7 +3558,9 @@ static NSCharacterSet *tokenSet = nil; * Return the content as an NSData object (unless it is multipart)
* Perform conversion from text to data using the charset specified in * the content-type header, or infer the charset, and update the header - * accordingly. + * accordingly.
+ * If the content can not be represented as a plain NSData object, this + * method returns nil. */ - (NSData*) convertToData { @@ -3589,6 +3593,7 @@ static NSCharacterSet *tokenSet = nil; /** * Return the content as an NSString object (unless it is multipart) + * If the content cannot be represented as text, this returns nil. */ - (NSString*) convertToText {