TOP --> CcDoc
CcDoc Token Format (CTF) handler.
CCcDocCtf
~CCcDocCtf
Add
GetXrefNodesByName
Read
Read
SetVerboseFlag
UpdateNodeId
Walk
WalkRoots
Write
Xref
public CCcDocCtf ( ) ;
Constructor.
public ~ CCcDocCtf ( ) ;
Destructor.
public void SetVerboseFlag ( bool f ) ;
Set the verbose flag.
| f | The flag. |
public void Add ( CCcDocParserNode * tree ) ;
Add a parse tree.
| tree | The parse tree. |
public void Read ( const char * ctf ) ;
Read a CTF file.
| ctf | The name of the ctf file. |
public void Read ( const char * ctf ,
CJdlStringList & excludeList ) ;
Read a CTF file with an exclude list. If the exclude list is not empty then the cross reference information will be ignored because it will be invalid.
| ctf | The name of the ctf file. |
| excludeList | The list of files to exclude. |
public void Write ( const char * ctf ,
const char * phase ) ;
Write a CTF file.
| ctf | The name of the new ctf file. |
| phase | The header in the file that indicates the phase of processing completed. |
public void Walk ( void ( * fct ) ( CCcDocParserNode * node , void * arg ) ,
void * arg ) ;
Walk through all of the nodes of all of the trees.
| fct | The callback function. |
| arg | A user argument. |
public void WalkRoots ( void ( * fct ) ( CCcDocParserNode * node , void * arg ) ,
void * arg ) ;
Walk through all of the root nodes of all of the trees.
| fct | The callback function. |
| arg | A user argument. |
public void Xref ( ) ;
Generate the cross reference information.
public CJdlVector < CCcDocParserNode * > * GetXrefNodesByName ( const char * name ) ;
Get the list of level 1 parser nodes associated with this name. This is used for cross referencing by name.
| name | The name of the node. |
public void UpdateNodeId ( CCcDocParserNode * node ) ;
Used by the callback functions to update a node id.
| node | The node. |
This documentation was generated automatically by the ccdoc tool (version 0.7a).
Click here to submit a bug report or feature request.
Click here to return to the top of the page.