Module

Generators

There's no documentation for this item.

Modules
MarkUp Handle common markup tasks for the various Html classes
Classes
AllReferences Build a hash of all items that can be cross-referenced. This is used when we output required and included names: if the names appear in this hash, we can generate an html cross reference to the appropriate description. We also use this when parsing comment blocks: any decorated words matching an entry in this list are hyperlinked.
CHMGenerator
ContextUser A Context is built by the parser to represent a container: contexts hold classes, modules, methods, require lists and include lists. ClassModule and TopLevel are the context objects we process here
HTMLGenerator
HTMLGeneratorInOne
HtmlClass Wrap a ClassModule context
HtmlFile Handles the mapping of a file’s information to HTML. In reality, a file corresponds to a TopLevel object, containing modules, classes, and top-level methods. In theory it could contain attributes and aliases, but we ignore these for now.
HtmlMethod
HyperlinkHtml Subclass of the SM::ToHtml class that supports looking up words in the AllReferences list. Those that are found (like AllReferences in this comment) will be hyperlinked
RIGenerator
XMLGenerator Generate XML output as one big file
Constants
CLASS_DIR
CSS_NAME
FILE_DIR Name of sub-direcories that hold file and class/module descriptions
Comments

Have your say
Please use Textile formatting (click here for a cheat sheet). Use <code/> and <pre/> for code samples.
Click here to login with OpenID to to post comments.