TOP --> CcDoc
This class manages the phase3 processing. This phase generates the HTML.
CCcDocPhase3
~CCcDocPhase3
Run
SetSwBgColor
SetSwFgColor
SetSwFlagGlobals
SetSwFlagGroupPkgIdx
SetSwFlagLocals
SetSwFlagMacros
SetSwFlagPrivates
SetSwFlagProtecteds
SetSwFlagPublics
SetSwFlagTypedefs
SetSwFlagVerbose
SetSwRootName
SetSwRootURL
public CCcDocPhase3 ( ) ;
Constructor.
public ~ CCcDocPhase3 ( ) ;
Destructor.
public bool Run ( CCcDocCtf & ctf ,
const char * html ,
const char * imageURL ,
const char * srcURL ,
const char * header ,
const char * trailer ,
bool mcfFlag ) ;
Run this phase.
| ctf | The repository. |
| html | The html directory. |
| imageurl | The image URL prefix. |
| srcurl | The source code URL prefix. |
| header | The HTML header file. The contents of this file are inserted right after the statement of generated files. It is used for local identification. |
| trailer | The HTML trailer file. It is used for local identification. |
| mcfFlag | Generate the packages data in the old multi-column format. This turns off the nifty pkg tree generation stuff. It should only be used in legacy systems that don't have pkg documentation. |
public void SetSwBgColor ( const char * c ) ;
Set the background color from the -bg switch.
| c | The new color. |
public void SetSwFgColor ( const char * c ) ;
Set the foreground color from the -fg switch.
| c | The new color. |
public void SetSwFlagGlobals ( bool f ) ;
Determine whether global nodes are reported.
| f | The flag. |
public void SetSwFlagLocals ( bool f ) ;
Determine whether local nodes are reported.
| f | The flag. |
public void SetSwFlagMacros ( bool f ) ;
Determine whether macros are reported.
| f | The flag. |
public void SetSwFlagGroupPkgIdx ( bool f ) ;
Determine whether the package index output is grouped by type.
| f | The flag. |
public void SetSwFlagPrivates ( bool f ) ;
Determine whether private nodes are reported.
| f | The flag. |
public void SetSwFlagProtecteds ( bool f ) ;
Determine whether protected nodes are reported.
| f | The flag. |
public void SetSwFlagPublics ( bool f ) ;
Determine whether public nodes are reported.
| f | The flag. |
public void SetSwFlagTypedefs ( bool f ) ;
Determine whether typedefs are reported.
| f | The flag. |
public void SetSwFlagVerbose ( bool f ) ;
Determine whether verbose mode is turned on for this phase.
| f | The flag. |
public void SetSwRootName ( const char * n ) ;
Set the root name alias. If this is not set the root name will default to [ROOT].
| n | The new name. |
public void SetSwRootURL ( const char * n ) ;
Set the root URL. Normally the root node is not a hyperlink. By setting this argument, it can be made to link anywhere. This is useful for integrating ccdoc output into larger documents.
| n | The root URL. |
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.