Minor documentation tweak

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@20370 72102866-910b-0410-8b05-ffd578937521

ChangeLog

@@ -1,3 +1,9 @@
+2004-11-23 Richard Frith-Macdonald <rfm@gnu.org>
+
+	* Source/NSProcessInfo.m:
+	* Source/NSUserDefaults.m:
+	Improve documentation of --GNU-Debug=...
+
 2004-11-22 Richard Frith-Macdonald <rfm@gnu.org>
 
 	* Source/NSPropertyList.m: Initialise harmless uninitialised variable

Source/NSProcessInfo.m

@@ -729,10 +729,17 @@ int main(int argc, char *argv[], char *env[])
 
 /**
  * Returns an array containing the arguments supplied to start this
- * process.  NB. In GNUstep, any arguments of the form --GNU-Debug=...
+ * process.<br />
+ * NB. In GNUstep, any arguments of the form --GNU-Debug=...
  * are <em>not</em> included in this array ... they are part of the
  * debug mechanism, and are hidden so that setting debug variables
- * will not effect the normal operation of the program.
+ * will not effect the normal operation of the program.<br />
+ * Please note, the special <code>--GNU-Debug=...</code> syntax differs from
+ * that which is used to specify values for the [NSUserDefaults] system.<br />
+ * User defaults are set on the command line by specifying the default name
+ * (with a leading hyphen) as one argument, and the default value as the
+ * following argument.  The arguments used to set user defaults are
+ * present in the array returned by this method.
  */
 - (NSArray *) arguments
 {

Source/NSUserDefaults.m

@@ -161,7 +161,13 @@ static void updateCache(NSUserDefaults *self)
  *   <term><code>NSArgumentDomain</code> ... volatile</term>
  *   <desc>
  *     Contains defaults read from the arguments provided
- *     to the application at startup.
+ *     to the application at startup.<br />
+ *     Pairs of arguments are used for this, with the first argument in
+ *     each pair being the name of a default (with a hyphen prepended)
+ *     and the second argument of the pair being the value of the defalt.<br />
+ *     NB. In GNUstep special arguments of the form <code>--GNU-Debug=...</code>
+ *     are used to enable debugging.  Despite beginning with a hyphen, these
+ *     are not treated as default keys.
  *   </desc>
  *   <term>Application (name of the current process) ... persistent</term>
  *   <desc>