Documentation tweaks

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

ChangeLog

@@ -1,7 +1,13 @@
 2002-11-04  Richard Frith-Macdonald <rfm@gnu.org>
 
-	* Source/NSArray.m: Ensurd some documentation in place for almost all
+	* Source/NSArray.m: Ensured some documentation in place for almost all
 	methods.
+	* Source/Additions/GSMime.m: Fix broken method reference.
+	* Source/Additions/GSXML.m: ditto
+	* Source/NSScanner.m: ditto
+	* Source/NSUnarchiver.m: ditto
+	* Tools/AGSIndex.m: Minor fix for superclass reference lookup.
+	* Tools/AGSHtml.m: ditto
 
 2002-11-03  Richard Frith-Macdonald <rfm@gnu.org>
 

Headers/gnustep/base/NSArchiver.h

@@ -22,7 +22,6 @@
    Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111 USA.
 
    AutogsdocSource: NSArchiver.m
-
    AutogsdocSource: NSUnarchiver.m
 
    */ 

Headers/gnustep/base/NSDebug.h

@@ -215,7 +215,7 @@ GS_EXPORT BOOL NSDeallocateZombies;
    </p>
    <p>NSUserDefaults also adds debug levels from the array given by the
    GNU-Debug key ... but these values will not take effect until the
-   +sharedUserDefaults method is called ... so they are useless for
+   +standardUserDefaults method is called ... so they are useless for
    debugging NSUserDefaults itsself or for debugging any code executed
    before the defaults system is used.
    </p>

Source/Additions/GSMime.m

@@ -599,7 +599,8 @@ wordData(NSString *word)
  * </p>
  * <p>
  *   On completion of parsing a valid document, the
- *   -document method returns the resulting parsed document.
+ *   [GSMimeDocument-mimeDocument] method returns the
+ *   resulting parsed document.
  * </p>
  */
 @implementation	GSMimeParser

Source/Additions/GSXML.m

@@ -1769,7 +1769,7 @@ static NSString	*endMarker = @"At end of incremental parse";
 
 /**
  * Set and return the previous value for blank text nodes support.
- * ignorableWhitespace() are only generated when running
+ * ignorableWhitespace nodes are only generated when running
  * the parser in validating mode and when the current element
  * doesn't allow CDATA or mixed content.
  */

Source/NSConnection.m

@@ -1225,8 +1225,8 @@ static BOOL	multi_threaded = NO;
 }
 
 /**
- * Simply invokes -registerName:usingNameServer: passing it the default
+ * Simply invokes -registerName:withNameServer:
- * system nameserver.
+ * passing it the default system nameserver.
  */
 - (BOOL) registerName: (NSString*)name
 {

Source/NSScanner.m

@@ -625,7 +625,7 @@ typedef struct {
  * placing it in <em>doubleValue</em> if that is not null.
  * Returns YES if anything is scanned, NO otherwise.
  * <br/>
- * On overflow, HUGE_VAL or -HUGE_VAL is put into <em>doubleValue</em>
+ * On overflow, HUGE_VAL or - HUGE_VAL is put into <em>doubleValue</em>
  * <br/>
  * On underflow, 0.0 is put into <em>doubleValue</em>
  * <br/>
@@ -750,7 +750,7 @@ typedef struct {
  * placing it in <em>floatValue</em> if that is not null.
  * Returns YES if anything is scanned, NO otherwise.
  * <br/>
- * On overflow, HUGE_VAL or -HUGE_VAL is put into <em>floatValue</em>
+ * On overflow, HUGE_VAL or - HUGE_VAL is put into <em>floatValue</em>
  * <br/>
  * On underflow, 0.0 is put into <em>floatValue</em>
  * <br/>

Source/NSURLHandle.m

@@ -191,7 +191,7 @@ static Class		NSURLHandleClass = 0;
 
 /**
  * Returns the most recently registered NSURLHandle subclass that
- * responds to -canInitWithURL: with YES.
+ * responds to +canInitWithURL: with YES.
  * If there is no such subclass, returns nil.
  */
 + (Class) URLHandleClassForURL: (NSURL*)url

Source/NSUnarchiver.m

@@ -296,7 +296,7 @@ mapClassName(NSUnarchiverObjectInfo *info)
  * This class reconstructs objects from an archive.<br />
  * <strong>Re-using the archiver</strong><br />
  * <p>
- *   The -resetUnarchiverWithdata:atIndex: method lets you re-use
+ *   The -resetUnarchiverWithData:atIndex: method lets you re-use
  *   the archive to decode a new data object or, in conjunction
  *   with the 'cursor' method (which reports the current decoding
  *   position in the archive), decode a second archive that exists
@@ -306,22 +306,19 @@ mapClassName(NSUnarchiverObjectInfo *info)
  * NSUnarchiver normally reads directly from an NSData object using
  * the methods -
  * <deflist>
- *   <term>[-deserializeTypeTagAtCursor:]</term>
+ *   <term>-deserializeTypeTag:andCrossRef:atCursor:</term>
  *   <desc>
  *     to decode type tags for data items, the tag is the
  *     first byte of the character encoding string for the
  *     data type (as provided by '@encode(xxx)'), possibly
  *     with the top bit set to indicate that what follows is
- *     a crossreference to an item already encoded.
+ *     a crossreference to an item already encoded.<br />
- *   </desc>
+ *     Also decode a crossreference number either to identify the
- *   <term>[-deserializeCrossRefAtCursor:]</term>
- *   <desc>
- *     to decode a crossreference number either to identify the
  *     following item, or to refer to a previously encoded item.
  *     Objects, Classes, Selectors, CStrings and Pointer items
  *     have crossreference encoding, other types do not.
  *   </desc>
- *   <term>[-deserializeData:ofObjCType:atCursor:context:]</term>
+ *   <term>[NSData-deserializeDataAt:ofObjCType:atCursor:context:]</term>
  *   <desc>
  *     to decode all other information.
  *   </desc>

Tools/AGSHtml.m

@@ -183,7 +183,7 @@ static NSMutableSet	*textNodes = nil;
   NSString	*kind = (f == YES) ? @"rel=\"gsdoc\" href" : @"name";
   NSString	*hash = (f == YES) ? @"#" : @"";
 
-  if (f == YES)
+  if (f == NO)
     {
       if (u == nil)
 	{

Tools/AGSIndex.m

@@ -662,7 +662,6 @@ setDirectory(NSMutableDictionary *dict, NSString *path)
       *u = nil;
       return nil;
     }
-
   if (*u == nil)
     {
       /**
@@ -708,6 +707,7 @@ setDirectory(NSMutableDictionary *dict, NSString *path)
       *u = [self globalRef: *u type: @"super"];
       if (*u != nil)
 	{
+	  *u = [*u lastPathComponent];
 	  s = [t objectForKey: *u];
 	  if (s != nil)
 	    {