From 8ac94e4d9a3b09a7c1a391f66d0097a2fa5483b7 Mon Sep 17 00:00:00 2001
From: Richard Frith-Macdonald <rfm@gnu.org>
Date: Mon, 11 Nov 2002 11:34:21 +0000
Subject: [PATCH] Complete plist documentation

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@14975 72102866-910b-0410-8b05-ffd578937521
---
 Source/NSArray.m      | 18 ++++++++++++++++++
 Source/NSDictionary.m | 24 ++++++++++++++++++++++++
 2 files changed, 42 insertions(+)

diff --git a/Source/NSArray.m b/Source/NSArray.m
index 14ac54cdf..294b90a8e 100644
--- a/Source/NSArray.m
+++ b/Source/NSArray.m
@@ -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
 {
diff --git a/Source/NSDictionary.m b/Source/NSDictionary.m
index 573694796..1d03da898 100644
--- a/Source/NSDictionary.m
+++ b/Source/NSDictionary.m
@@ -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
 {