DelphiCodeToDoc Previous Next
Name
TDOCGeneratorBase
Parent
uDocGeneratorBase
Class Hierarchy
TObject
Visibility
PUBLIC
Description
Base class for all document generators
Members
Fields
Field Description FDOCOptions (-) Options of the project FDocStructure (-) Structure of the project FGeneratorVisitor (-) Visitor used to access all items in the structure FMessageStrings (-) Messages for the user interface
Methods
Method Description BuildFolders (#) Build folders needed for this generator Create (+) Create a new TDOCGeneratorBase instance CreateVisitor (#) Create (Class Factory) and link a new visitor for this generator Destroy (+) destroy a previsouly created TDOCGeneratorBase instance DoVisit (#) Visit and Build documentation for this DocTemplate EvaluateItemDisplay (+) Evaluate if the visit of this DocTemplate is enabled Execute (+) Execute the generator (build the document) GetNext (-) Get Next visited item GetOutputFile (+) Get the main output file of the final documentation GetPrevious (-) Get previously visited item SendStatusMessage (#) Send a message reflecting the status of the operations in progress VerifyCondition (+) Verify if all conditions met to build the documentation
Properties
Property Description DOCOptions (#) Options of the project DocStructure (#) Structure of the project MessageStrings (+) Messages for the user interface NextItem (#) Get Next visited item PreviousItem (#) Get previously visited item
Legend
Symbol Visibility - Private # Protected + Public * Published A Automated S Strict
DelphiCodeToDoc Previous Next