This class is used by SCDoc to represent a document in the help file index.
The document represented can be either a real .schelp file, or an auto-generated stub for undocumented classes.
Create and initialize a new instance.
| node |
An SCDocNode instance. Does not have to be a fully parsed document, since only the header tags, methods and keywords are used. (See SCDoc: *parseFileMetaData). |
| path |
A String for the document key, like "Classes/SinOsc". |
Create and initialize a new instance for an undocumented class.
| name |
Name of undocumented class |
A String for the document key, like "Reference/SCDocSyntax".
Document title. Should equal the classname for class reference docs.
Document summary.
Document categories. An Array of Strings.
Related document links. An Array of Strings.
Keywords listed in the document. An Array of Strings.
The full path to this documents .schelp file, if any.
The modification time of the .schelp file, if any.
The render destination path.
Documented methods which are not class or instance methods. An Array of Strings.
A list of document additions (*.ext.schelp) for this document. An Array of Strings.
True if this document is an extension (not part of the main library). A Boolean
True if this document is a class doc. A Boolean
These methods and properties are only used for class docs.
The Class documented.
True if this class is undocumented (which means there are no .schelp file). A Boolean
A list of documented class methods.
A list of documented instance methods.
A list of private class methods.
A list of private instance methods.
A list of undocumented class methods.
A list of undocumented instance methods.
Return a list of strings for all non-private methods, prefixed with xy where x is _ for documented methods and ? for undocumented methods, and y is * for class methods, - for instance methods and . for other/generic methods.
The name of the class variable holding the implementing class. Used by GUI redirection system, for example.
The implementing Class, if redirect was set.
Write a representation of this document entry as JSON to Stream. Used to export the document entries to the javascript used in the HTML help browser.
| stream |
A Stream. |