DelphiCodeToDoc
Name
TDOCProject
Parent
uDocProject
Class Hierarchy
TObject
Visibility
PUBLIC
Description
Main Class that manage the Parser, the Structure Builder and the Generator
to build the Documentation from the source code in the configured format
Members
Fields
Field Description FCheckingFilename (-) Name of file currently processing FdmDebugMessages (-) Reference for writting Debug messages FdmUserMessages (-) Reference for writting User messages FDocOptions (-) project's Options shared with Generator. FDocStructure (-) Holds the skeleton of the source code FFileList (-) List of all file that will be processed FFileName (-) FileName (Not used) FisChecked (-) Specified if project has already been checked FOutputMainFileName (-) Name of the saved file FState (-) State of the project (New, Checked of Built)
Methods
Method Description AfterCheck (+) Process Tag coverage after check AnalyseItemType (-) Analyse string item written in configuration 'Included files' to see if it Build (+) Build the project by creating the output files BuildFileList (-) Build a file list filtered with PAS extension Check (+) Verify if Project can be build CheckFile (-) Check and parse a delphi source code file Create (+) Creates and initializes a TDOCProject Destroy (+) Destroy a TDOCProject reference GetStructure (+) Return the Structure of a project ParseDPRFile (+) Analyse DPR file to extract units name and path ParseFileList (+) Parse a file list PurgeOutputFolder (+) Delete all items in folder to Trash SearchForIgnore (-) Search in generated FileList if some match the ignore list. SetDestinationMessages (+) Configure the User output and Debug output to inform about the status ShowStatusMessage (+) Add a error message about the current process of a file
Properties
Property Description CheckingFilename (+) Name of file currently processing DocOptions (+) project's Options shared with Generator. FileName (+) FileName (Not used) isChecked (+) Specified if project has already been checked OutputMainFileName (+) Name of the saved file State (+) State of the project (New, Checked of Built)
Legend
Symbol Visibility - Private # Protected + Public * Published A Automated S Strict
DelphiCodeToDoc