AST Formatting Strategies.
This module contains all the builtin formatting strategies used to make the main scope pages. These strategies are used by Strategy.Summary/Detail to create the entries for each declaration - each has a list of strategies that it calls in turn to generate a HTML fragment for each declaration. So for example, a link to source code is added just by adding a Strategy (eg: FilePages) that outputs the link to the source. This can be done without changing the strategies that generate the declaration name, type or comments.
Classes Summary: | |
Strategy Generates HTML fragment for a declaration. [Source] | |
BaseAST Base class for SummaryAST and DetailAST. [Source] | |
SummaryAST Derives from BaseStrategy to provide summary-specific methods. [Source] | |
Default A base AST strategy that calls formatDeclaration for all types [Source] | |
SummaryCommenter Adds summary comments to all declarations [Source] | |
SourceLinker Adds a link to the decl on the file page to all declarations [Source] | |
XRefLinker Adds an xref link to all declarations [Source] | |
Heading Formats the top of a page - it is passed only the Declaration that the page is for (a Module or Class). [Source] | |
DetailAST Derives BaseAST to provide detail-specific AST formatting. [Source] | |
DetailCommenter Adds summary comments to all declarations [Source] | |
ClassHierarchySimple Prints a simple text hierarchy for classes [Source] | |
ClassHierarchyGraph Prints a graphical hierarchy for classes, using the Dot formatter. [Source] | |
Inheritance Prints just the name of each declaration, with a link to its doc [Source] |