The DocBlock class represents a single atom of documentation.
A documentation block is written as a C multi-line comment and documents a single class or a single function. DocBlock knows how to generate output for itself.
Constructs a DocBlock from sourceFile, which starts at sourceLine, has source text and documents className.
Constructs a DocBlock from sourceFile, which starts at sourceLine, has source text and documents function.
Constructs a DocBlock from sourceFile, which starts at sourceLine, has source text and documents intro.
Verifies that all state is appropriate for ending a paragraph or documentation block, and emits appropriate errors if not. l must be the line number at which the paragraph/doc block ends.
Parses the text() and calls the Output functions on to generate suitable output.
Generates the routine text that introduces the documentation for each class, e.g. what the class inherits.
Outputs boilerplante and genetated text to create a suitable headline and lead-in text for this DocBlock's function.
Generates routine text to introduce an introduction. Yay!
Returns true if this DocBlock documents a class, and false if not.
Returns true if this DocBlock documents an enum type, and false if not. At the moment, enums aren't supported; that'll change.
Handles the "\overload" directive. l is the line number where directive was seen and n is the word number (0 for the first word in a documentation block).
Adds the plain word or link w to the documentation, reporting an error from line l if the link is dangling.
Sets the DocBlock to state newState based on directive w, and gives an error from line l if the transition from the old state to the new is somehow wrong.
Returns the source text of the documentation.
Steps past whitespace, modifying the character index i and the line number l.
Steps past and processes a word, which in this context is any nonwhitespace. i is the character index, which is moved, l is the line number, and n is the word number.
This web page based on source code belonging to Oryx Mail Systems GmbH. All rights reserved.