DelphiCodeToDoc
Previous
Next

Name
  TDOCStructure

Parent
  uDocStructure

Class Hierarchy
  TDOCTemplate

Visibility
  PUBLIC

Description
  Specialized TDOCTemplate class for the whole structure itself

Members
  Fields
 
Field Description
FClassTree (-) All classes in a tree
FDOCOptions (-) All Options. Beware! Shared Component.
FProgram (-) Program (DPR file) associate with structure (also a unit)
FUnits (-) List of all units in the structure

Methods
 
Method Description
Clear (+) Clear all units from the structure
ConsolidateProject (+) Link all data and finalize process
ConvertAllToTreeNode (+) Converts the structure into a treenode
ConvertToTreeNode (-) Convert whole structure to a treenode
Create (+) Call Create to instantiate a TDOCStructure object at runtime.
Destroy (+) Destroys of an instance of a TDOCStructure object and free its content
FillTagDetail (+) Fill a RichEdit with details about Tags
FixFunctionTypeComment (-) Fix comments for function type, can be execute only at end of parse process
FixInheritance (-) Fix inheritance by filling items with ancestor comments
FixSelfTag (-) Convert some DocOptions to structure TAG
GetProgram (+) Return the linked Program (Delphi DPR)
GetTemplateName (+) Return the name of this template
SetProgram (+) Link the Program (Delphi DPR) to the structure.
SortContent (+) Sort all DocTemplate element of lists in alphabetical order
UpdateAllTagCoverage (-) Update Tag coverage for all item in structure

Properties
 
Property Description
ClassTree (+) All classes in a tree
DOCOptions (+) All Options. Beware! Shared Component.
UnitList (+) List of all units in the structure


Legend
 
Symbol Visibility
- Private
# Protected
+ Public
* Published
A Automated
S Strict

DelphiCodeToDoc
Previous
Next


TridenT - 2009 - Under GNU GPL Licence
Created with DelphiCodeToDoc. To obtain the latest revision, please visit http://dephicodetodoc.sourceforge.net/