DelphiCodeToDoc
Name
TDocGeneratorHtml
Parent
uDocGeneratorHtml
Class Hierarchy
TDOCGeneratorBase
Visibility
PUBLIC
Description
HTML documentation generator
Members
Fields
Field Description FCSSShortFilename (-) CSS filename (not including path) linked to the HTML project FGenHTML (-) Output writer component FHtmlOutputFolder (-) Output folder to store HTML page
Methods
Method Description AddLine (-) Add a line to the output AddToolBar (-) Add the toolbar to the HTML page BuildFolders (#) Build folders needed for this generator Create (+) Create a new TDOCGeneratorBase instance DoVisit (#) Visit and Build documentation for this DocTemplate GetClassTreeLink (-) Get relative path to the class tree from a DocTemplate GetCssFolder (-) Get the CSS folder from the output directory GetHTMLIndex (-) Build the Index documentation section GetHTMLMemberVisibility (-) Build the HTML member visibility symbols GetImgFolder (-) Get the 'image' folder path including the trailing path delimiter GetOutputFile (+) Return the name of the main generated file from Generator GetRelativePathToItem (-) Get a relative pathname to an item from another GetRelativePathToParent (-) Get a relative pathname to the parent item IterateClassNode (-) Iterate a Class node to create a Class hierarchy in TEXT format WriteClassHierarchy (-) Build the class section of the documentation WriteDocTemplateList (-) Write a DocTemplateList content with all items and their summary WriteLegend (-) Write Legend - Member visibility symbol - at the end of he document WriteMemberVisibilityText (-) Write in HTML doc the member visibility in text format. WritePageFooter (-) Write documentation Page footer WritePageHeader (-) Write documentation Page header WriteParamReturnTAGSection (-) Build the specific parameter from the @return TAG section of a Method WriteReturnTAGSection (-) Build the specific @return TAG section from a Method WriteSimpleTAGSection (-) Build a simple TAG section (no color) from a Template WriteTAGSection (-) Build a colored TAG section of a Template WriteTemplateSection (-) Write a section in HTML format for the current Item
Properties
Property Description HtmlOutputFolder (#) Output folder to store HTML page
Legend
Symbol Visibility - Private # Protected + Public * Published A Automated S Strict
DelphiCodeToDoc