From ba86429fb39603c6ce1e71b7c39962ed390af624 Mon Sep 17 00:00:00 2001 From: arobert Date: Tue, 22 Jun 2004 22:52:44 +0000 Subject: [PATCH] add/improve gsdoc comments git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@19591 72102866-910b-0410-8b05-ffd578937521 --- Tools/AGSOutput.m | 7 +++++-- Tools/AGSParser.m | 4 ++++ Tools/gdnc.m | 2 +- 3 files changed, 10 insertions(+), 3 deletions(-) diff --git a/Tools/AGSOutput.m b/Tools/AGSOutput.m index 3e2e60d84..44d17af18 100644 --- a/Tools/AGSOutput.m +++ b/Tools/AGSOutput.m @@ -78,7 +78,10 @@ static BOOL snuggleStart(NSString *t) *

* * And finally, here is the actual class description ... outside the chapter. - * With a reference to escapeType() in it. + * This is the class description for AGSOutput, including some + * sample uses of GSDoc, such as cross-references (see [NSString]). + * Functions, like escapeType(), are automatically referenced (if they are + * found). */ @implementation AGSOutput @@ -2303,7 +2306,7 @@ static BOOL snuggleStart(NSString *t) /* * If a -Up default has been set, create an up link in this * template file... as long as the specified up link is not - * the template file itsself. + * the template file itself. */ if (up != nil && [up isEqual: [name lastPathComponent]] == NO) { diff --git a/Tools/AGSParser.m b/Tools/AGSParser.m index baceb839f..03b9bff12 100644 --- a/Tools/AGSParser.m +++ b/Tools/AGSParser.m @@ -22,6 +22,10 @@ #include "GNUstepBase/GNUstep.h" #include "GNUstepBase/GSCategories.h" +/** + * The AGSParser class parses Objective-C header and source files + * to produce a property-list which can be handled by [AGSOutput]. + */ @implementation AGSParser /** diff --git a/Tools/gdnc.m b/Tools/gdnc.m index 212a7473b..13df2f26f 100644 --- a/Tools/gdnc.m +++ b/Tools/gdnc.m @@ -348,7 +348,7 @@ ihandler(int sig) } /* - * Now free the connections map itsself and the table of observers. + * Now free the connections map itself and the table of observers. */ NSFreeMapTable(connections); NSFreeHashTable(allObservers);