add/improve gsdoc comments

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@19591 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
arobert 2004-06-22 22:52:44 +00:00
parent f1a40bca36
commit ba86429fb3
3 changed files with 10 additions and 3 deletions

View file

@ -78,7 +78,10 @@ static BOOL snuggleStart(NSString *t)
* </p> * </p>
* </unit> * </unit>
* And finally, here is the actual class description ... outside the chapter. * And finally, here is the actual class description ... outside the chapter.
* With a reference to escapeType() in it. * This is the class description for <code>AGSOutput</code>, including some
* sample uses of GSDoc, such as cross-references (see [NSString]).
* Functions, like escapeType(), are automatically referenced (if they are
* found).
*/ */
@implementation AGSOutput @implementation AGSOutput
@ -2303,7 +2306,7 @@ static BOOL snuggleStart(NSString *t)
/* /*
* If a -Up default has been set, create an up link in this * If a -Up default has been set, create an up link in this
* template file... as long as the specified up link is not * 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) if (up != nil && [up isEqual: [name lastPathComponent]] == NO)
{ {

View file

@ -22,6 +22,10 @@
#include "GNUstepBase/GNUstep.h" #include "GNUstepBase/GNUstep.h"
#include "GNUstepBase/GSCategories.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 @implementation AGSParser
/** /**

View file

@ -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); NSFreeMapTable(connections);
NSFreeHashTable(allObservers); NSFreeHashTable(allObservers);