# AGSOutput... a class to output gsdoc source

richard@brainstorm.co.uk
2001 Free Software Foundation, Inc.
The AGSOutput class

This is a really great class... but it's not really reusable since it's far too special purpose.

AGSOutput.h
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, like escapeType() , are automatically referenced (if they are found).
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
checkComment:
comment
unit:
unit
info:
d
Description forthcoming.
fitWords:
a
from:
start
to:
end
maxSize:
limit
output:
buf
Description forthcoming.
informalProtocols
Description forthcoming.
output:
d
Return an array containing the names of any files modified as a result of outputing the specified data structure.
outputDecl:
d
kind:
kind
to:
str
Uses -split: and -reformat:withIndent:to: .
outputFunction:
d
to:
str
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.
outputInstanceVariable:
d
to:
str
for:
unit
Output the gsdoc code for an instance variable.
outputMacro:
d
to:
str
Uses -split: and -reformat:withIndent:to: .
outputMethod:
d
to:
str
for:
unit
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.
outputUnit:
d
to:
str
Description forthcoming.
reformat:
str
withIndent:
ind
to:
buf
Description forthcoming.
split:
str
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?

Here is the afterword for the class.

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).