Complete plist documentation

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@14975 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Richard Frith-Macdonald 2002-11-11 11:34:21 +00:00
parent e3be05fe04
commit 8ac94e4d9a
2 changed files with 42 additions and 0 deletions

View file

@ -965,16 +965,34 @@ static int compare(id elem1, id elem2, void* context)
return AUTORELEASE(e);
}
/**
* Returns the result of invoking -descriptionWithLocale:indent: with a nil
* locale and zero indent.
*/
- (NSString*) description
{
return [self descriptionWithLocale: nil];
}
/**
* Returns the result of invoking -descriptionWithLocale:indent:
* with a zero indent.
*/
- (NSString*) descriptionWithLocale: (NSDictionary*)locale
{
return [self descriptionWithLocale: locale indent: 0];
}
/**
* Returns the receiver as a text property list in the traditional format.<br />
* See [NSString-propertyList] for details.<br />
* If locale is nil, no formatting is done, otherwise entries are formatted
* according to the locale, and indented according to level.<br />
* Unless locale is nil, a level of zero indents items by four spaces,
* while a level of one indents them by a tab.<br />
* The items in the property list string appear in the same order as
* they appear in the receiver.
*/
- (NSString*) descriptionWithLocale: (NSDictionary*)locale
indent: (unsigned int)level
{

View file

@ -782,11 +782,20 @@ compareIt(id o1, id o2, void* context)
writeToURL: url atomically: useAuxiliaryFile];
}
/**
* Returns the result of invoking -descriptionWithLocale:indent: with a nil
* locale and zero indent.
*/
- (NSString*) description
{
return [self descriptionWithLocale: nil indent: 0];
}
/**
* Returns the receiver as a text property list strings file format.<br />
* See [NSString-propertyListFromStringsFileFormat] for details.<br />
* The order of the items is undefined.
*/
- (NSString*) descriptionInStringsFileFormat
{
NSMutableString *result = nil;
@ -811,11 +820,26 @@ compareIt(id o1, id o2, void* context)
return result;
}
/**
* Returns the result of invoking -descriptionWithLocale:indent: with
* a zero indent.
*/
- (NSString*) descriptionWithLocale: (NSDictionary*)locale
{
return [self descriptionWithLocale: locale indent: 0];
}
/**
* Returns the receiver as a text property list in the traditional format.<br />
* See [NSString-propertyList] for details.<br />
* If locale is nil, no formatting is done, otherwise entries are formatted
* according to the locale, and indented according to level.<br />
* Unless locale is nil, a level of zero indents items by four spaces,
* while a level of one indents them by a tab.<br />
* If the keys in the dictionary respond to -compare:, the items are
* listed by key in ascending order. If not, the order in which the
* items are listed is undefined.
*/
- (NSString*) descriptionWithLocale: (NSDictionary*)locale
indent: (unsigned int)level
{