Small documentation improvement.

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@23187 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Richard Frith-MacDonald 2006-07-26 11:14:53 +00:00
parent d3441290bf
commit 299b25f471
3 changed files with 24 additions and 7 deletions

View file

@ -1,3 +1,9 @@
2006-07-26 Richard Frith-Macdonald <rfm@gnu.org>
* Source/Additions/GSMime.m: Remove a couple of comments
* Headers/Additions/GNUstepBase/GSMime.h: Add improved documentation
for the bas64 conversion methods.
2006-07-25 Richard Frith-Macdonald <rfm@gnu.org>
* Source/NSKeyedUnarchiver.m: Reinstate fix of 2006-07-14 which was

View file

@ -20,7 +20,8 @@
You should have received a copy of the GNU Library General Public
License along with this library; if not, write to the Free
Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111 USA.
Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02111 USA.
AutogsdocSource: Additions/GSMime.m
*/
@ -96,11 +97,27 @@
}
+ (NSString*) charsetFromEncoding: (NSStringEncoding)enc;
/**
* Decode the source data from base64 encoding and return the result.<br />
* The source data is expected to be ASCII text and may be multiple
* lines or a line of any length (decoding is very tolerant).
*/
+ (NSData*) decodeBase64: (NSData*)source;
+ (NSString*) decodeBase64String: (NSString*)source;
+ (GSMimeDocument*) documentWithContent: (id)newContent
type: (NSString*)type
name: (NSString*)name;
/**
* Encode the source data to base64 encoding and return the result.<br />
* The resulting data is ASCII text and contains only the base64 encoded
* values with no line breaks or extraneous data. This is base64 encoded
* data in it's general format as mandated in RFC 3548. If the data is
* to be used as part of a MIME document body, line breaks must be
* introduced at 76 byte intervals (GSMime does this when automatically
* encoding data for you). If the data is to be used in a PEM document
* line breaks must be introduced at 74 byte intervals.
*/
+ (NSData*) encodeBase64: (NSData*)source;
+ (NSString*) encodeBase64String: (NSString*)source;
+ (NSStringEncoding) encodingFromCharset: (NSString*)charset;

View file

@ -3325,9 +3325,6 @@ static NSCharacterSet *tokenSet = nil;
return charset;
}
/**
* Decode the source data from base64 encoding and return the result.
*/
+ (NSData*) decodeBase64: (NSData*)source
{
int length;
@ -3460,9 +3457,6 @@ static NSCharacterSet *tokenSet = nil;
return doc;
}
/**
* Encode the source data to base64 encoding and return the result.
*/
+ (NSData*) encodeBase64: (NSData*)source
{
int length;