From 4a1aab94a61b7d762ef90708e034248b43ea2362 Mon Sep 17 00:00:00 2001 From: CaS Date: Mon, 4 Nov 2002 15:39:43 +0000 Subject: [PATCH] Documentation tweaks git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@14923 72102866-910b-0410-8b05-ffd578937521 --- ChangeLog | 8 +++++++- Headers/gnustep/base/NSArchiver.h | 1 - Headers/gnustep/base/NSDebug.h | 2 +- Source/Additions/GSMime.m | 3 ++- Source/Additions/GSXML.m | 2 +- Source/NSConnection.m | 4 ++-- Source/NSScanner.m | 4 ++-- Source/NSURLHandle.m | 2 +- Source/NSUnarchiver.m | 13 +++++-------- Tools/AGSHtml.m | 2 +- Tools/AGSIndex.m | 2 +- 11 files changed, 23 insertions(+), 20 deletions(-) diff --git a/ChangeLog b/ChangeLog index 7b7554f38..c4edbb549 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,7 +1,13 @@ 2002-11-04 Richard Frith-Macdonald - * 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 diff --git a/Headers/gnustep/base/NSArchiver.h b/Headers/gnustep/base/NSArchiver.h index 39f14e2d5..53d85460b 100644 --- a/Headers/gnustep/base/NSArchiver.h +++ b/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 */ diff --git a/Headers/gnustep/base/NSDebug.h b/Headers/gnustep/base/NSDebug.h index 338a0fa89..0468d3659 100644 --- a/Headers/gnustep/base/NSDebug.h +++ b/Headers/gnustep/base/NSDebug.h @@ -215,7 +215,7 @@ GS_EXPORT BOOL NSDeallocateZombies;

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.

diff --git a/Source/Additions/GSMime.m b/Source/Additions/GSMime.m index d7e1f7820..65226b305 100644 --- a/Source/Additions/GSMime.m +++ b/Source/Additions/GSMime.m @@ -599,7 +599,8 @@ wordData(NSString *word) *

*

* On completion of parsing a valid document, the - * -document method returns the resulting parsed document. + * [GSMimeDocument-mimeDocument] method returns the + * resulting parsed document. *

*/ @implementation GSMimeParser diff --git a/Source/Additions/GSXML.m b/Source/Additions/GSXML.m index 90034efcb..488ee2494 100644 --- a/Source/Additions/GSXML.m +++ b/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. */ diff --git a/Source/NSConnection.m b/Source/NSConnection.m index 625eb3ed6..69e3acf55 100644 --- a/Source/NSConnection.m +++ b/Source/NSConnection.m @@ -1225,8 +1225,8 @@ static BOOL multi_threaded = NO; } /** - * Simply invokes -registerName:usingNameServer: passing it the default - * system nameserver. + * Simply invokes -registerName:withNameServer: + * passing it the default system nameserver. */ - (BOOL) registerName: (NSString*)name { diff --git a/Source/NSScanner.m b/Source/NSScanner.m index 5e99a1522..7603b9b59 100644 --- a/Source/NSScanner.m +++ b/Source/NSScanner.m @@ -625,7 +625,7 @@ typedef struct { * placing it in doubleValue if that is not null. * Returns YES if anything is scanned, NO otherwise. *
- * On overflow, HUGE_VAL or -HUGE_VAL is put into doubleValue + * On overflow, HUGE_VAL or - HUGE_VAL is put into doubleValue *
* On underflow, 0.0 is put into doubleValue *
@@ -750,7 +750,7 @@ typedef struct { * placing it in floatValue if that is not null. * Returns YES if anything is scanned, NO otherwise. *
- * On overflow, HUGE_VAL or -HUGE_VAL is put into floatValue + * On overflow, HUGE_VAL or - HUGE_VAL is put into floatValue *
* On underflow, 0.0 is put into floatValue *
diff --git a/Source/NSURLHandle.m b/Source/NSURLHandle.m index cbf5bad2a..4a0b4e6e8 100644 --- a/Source/NSURLHandle.m +++ b/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 diff --git a/Source/NSUnarchiver.m b/Source/NSUnarchiver.m index 954a77585..22163ebac 100644 --- a/Source/NSUnarchiver.m +++ b/Source/NSUnarchiver.m @@ -296,7 +296,7 @@ mapClassName(NSUnarchiverObjectInfo *info) * This class reconstructs objects from an archive.
* Re-using the archiver
*

- * 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 - * - * [-deserializeTypeTagAtCursor:] + * -deserializeTypeTag:andCrossRef:atCursor: * * 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. - * - * [-deserializeCrossRefAtCursor:] - * - * to decode a crossreference number either to identify the + * a crossreference to an item already encoded.
+ * Also 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. * - * [-deserializeData:ofObjCType:atCursor:context:] + * [NSData-deserializeDataAt:ofObjCType:atCursor:context:] * * to decode all other information. * diff --git a/Tools/AGSHtml.m b/Tools/AGSHtml.m index 7ffea866b..bd75e4e66 100644 --- a/Tools/AGSHtml.m +++ b/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) { diff --git a/Tools/AGSIndex.m b/Tools/AGSIndex.m index 7182ff353..8f06a2a7b 100644 --- a/Tools/AGSIndex.m +++ b/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) {