And finally, here is the actual class description...
outside the chapter. This is the class description
for AGSOutput, including some sample uses of
GSDoc, such as cross-references (see
NSString
). Functions, (recognised as an identifier immediately
followed by open and closing brackets), are
automatically referenced (if they are found).
- (void) outputFunction: (NSMutableDictionary*)d to: (NSMutableString*)str;
Availability: OpenStep
Uses -split:
and
-reformat:withIndent:to:
. Place the names of function arguments in a
temporary array 'args' so that they will be
highlighted if they appear in the function
description.
- (void) outputMethod: (NSMutableDictionary*)d to: (NSMutableString*)str for: (NSString*)unit;
Availability: OpenStep
Uses -split:
and
-reformat:withIndent:to:
. Also has fun with YES, NO,
and nil. Check special markup which
should be removed from the text actually placed in
the gsdoc method documentation... the special markup is
included in the gsdoc markup differently.
Split comment text into an array of words (to be
reformatted) and insert markup for cross
referencing and highlighting. Phase 1...
we take the supplied string and check for white space.
Any white space sequence is deleted and treated as a
word separator except within xml element markup. The
format of element start and end marks is tidied for
consistency. The resulting data is made into
an array of strings, each containing either an element
start or end tag, or one of the whitespace separated
words. What about str?
And here is some automated cross referencing... A method in
a protocol:
<NSCopying>-copyWithZone:
, a class:
NSString
, a protocol:
<NSCopying>
, and a category: NSRunLoop(GNUstepExtensions)
.