DelphiCodeToDoc

Name
  TDOCTemplate

Parent
  uDocTemplate

Class Hierarchy
  TObject

Visibility
  PUBLIC

Description
  Base class for Classes, members, ... in the final structure

Members
  Fields
 
Field Description
BodySource (+) Source code of the expression
FName (-) Name of the item, often time an identifier
FRelatedParent (-) Logical Parent of this item
FTagCoverageHolder (-) Tags coverage statistics and details
FTAGHolderList (-) Holder for all item's TAG
FTemplateListList (#) List of all Template lists
Hidden (+) Hidden if defined in implememtation section only
Links (+) of TDOCLinks
RelatedType (+) TDOCLink;

Methods
 
Method Description
AddLink (+) Add a link to the Link List (NOT USED FOR THE MOMENT)
BuildPathName (+) Build a base filename with all parent's name separated with underscore
BuildRelativePathName (+) Build a base filename with last parent's name separated with underscore
CategoryType (+) Check if template item is required in the output documentation.
CheckTagCoverage (#) Check if imperative TAGs are documented.
CopyCommentsFrom (+) Copy all comments (and TAG) from another TDocTemplate
Create (+) Call Create to instantiate a TDOCTemplate object at runtime.
CreateDocTemplateList (#) Create a TDocTemplate list from factory and add it to the list of this object.
Destroy (+) Destroys an instance of a TDOCTemplate object
GetFileName (+) Get the filename of this component
GetParentName (+) Return the name of the parent (owner)
GetTemplateName (+) Return the name of this template
UpdateTagCoverage (+) Update the TAG coverage statistics

Properties
 
Property Description
NAME (+) Name of the item, often time an identifier
RelatedParent (+) Logical Parent of this item
TagCoverageHolder (+) Tags coverage statistics and details
TAGHolderList (+) Holder for all item's TAG
TemplateListList (+) List of all Template lists


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

DelphiCodeToDoc


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