PUBLIC

DocPageC::DocPageC(const StringC &,const StringC &,const StringC &,const StringC &) DocPageC::GetName(void) const DocPageC::GetDocFilename(void) const DocPageC::GetBrief(void) const DocPageC::GetTypeIndex(void) const DocPageC::GetLevelIndex(void) const

DocPageC
include	"amma/DocEntry.hh"
User Level:	Default
Library:	DocEntry
Example:	exEndPoint.cc
Section:	Utilities.Documentation
In Scope:	std

Comments:
//////////////////////////////////////////////////////////////////////////

StringC _name;

StringC docFilename;

Where to look for the documentation on this object.

StringC _userlevel;

StringC _brief;

DocPageC(const StringC & name,const StringC & docFilename,const StringC & userlevel,const StringC & brief)

Constructor

name	the name of the page
userlevel	the userlevel of the page
brief	brief comment for the page

const StringC GetName() const

Access to the name of the page

const StringC GetDocFilename() const

Access to the name of the page

const StringC GetBrief() const

Access to the brief comment for the page

const IndexT GetTypeIndex() const

The index for the type of page, eg class, library, executable etc

const IndexT GetLevelIndex() const

The index for the userlevel of the page