Google 

TOP --> CcDoc
class CCcDocPhase3

This class manages the phase3 processing. This phase generates the HTML.

Author:
Joe Linoff

Version:
$Id: ccdocphase3.h,v 1.6 1999/06/12 18:10:33 jdl Exp $

Source:
../../ccdoc/src/ccdocphase3.h:181

Constructors Index

CCcDocPhase3
[public] Constructor.
~CCcDocPhase3
[public] Destructor.

Methods Index

Run
[public] Run this phase.
SetSwBgColor
[public] Set the background color from the -bg switch.
SetSwFgColor
[public] Set the foreground color from the -fg switch.
SetSwFlagGlobals
[public] Determine whether global nodes are reported.
SetSwFlagGroupPkgIdx
[public] Determine whether the package index output is grouped by type.
SetSwFlagLocals
[public] Determine whether local nodes are reported.
SetSwFlagMacros
[public] Determine whether macros are reported.
SetSwFlagPrivates
[public] Determine whether private nodes are reported.
SetSwFlagProtecteds
[public] Determine whether protected nodes are reported.
SetSwFlagPublics
[public] Determine whether public nodes are reported.
SetSwFlagTypedefs
[public] Determine whether typedefs are reported.
SetSwFlagVerbose
[public] Determine whether verbose mode is turned on for this phase.
SetSwRootName
[public] Set the root name alias. If this is not set the root name will default to [ROOT].
SetSwRootURL
[public] 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.

Constructors

CCcDocPhase3 

public CCcDocPhase3 ( ) ;

Constructor.

CCcDocPhase3 

public ~ CCcDocPhase3 ( ) ;

Destructor.

Methods

Run 

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.

Parameters:
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 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.

SetSwBgColor 

public void SetSwBgColor ( const char * c ) ;

Set the background color from the -bg switch.

Parameters:
c The new color.

SetSwFgColor 

public void SetSwFgColor ( const char * c ) ;

Set the foreground color from the -fg switch.

Parameters:
c The new color.

SetSwFlagGlobals 

public void SetSwFlagGlobals ( bool f ) ;

Determine whether global nodes are reported.

Parameters:
f The flag.

SetSwFlagLocals 

public void SetSwFlagLocals ( bool f ) ;

Determine whether local nodes are reported.

Parameters:
f The flag.

SetSwFlagMacros 

public void SetSwFlagMacros ( bool f ) ;

Determine whether macros are reported.

Parameters:
f The flag.

SetSwFlagGroupPkgIdx 

public void SetSwFlagGroupPkgIdx ( bool f ) ;

Determine whether the package index output is grouped by type.

Parameters:
f The flag.

SetSwFlagPrivates 

public void SetSwFlagPrivates ( bool f ) ;

Determine whether private nodes are reported.

Parameters:
f The flag.

SetSwFlagProtecteds 

public void SetSwFlagProtecteds ( bool f ) ;

Determine whether protected nodes are reported.

Parameters:
f The flag.

SetSwFlagPublics 

public void SetSwFlagPublics ( bool f ) ;

Determine whether public nodes are reported.

Parameters:
f The flag.

SetSwFlagTypedefs 

public void SetSwFlagTypedefs ( bool f ) ;

Determine whether typedefs are reported.

Parameters:
f The flag.

SetSwFlagVerbose 

public void SetSwFlagVerbose ( bool f ) ;

Determine whether verbose mode is turned on for this phase.

Parameters:
f The flag.

SetSwRootName 

public void SetSwRootName ( const char * n ) ;

Set the root name alias. If this is not set the root name will default to [ROOT].

Parameters:
n The new name.

SetSwRootURL 

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.

Parameters:
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.