PUBLIC

DocNodeC::DocNodeC(void) DocNodeC::operator=(const DocNodeC &) DocNodeC::SetNames(const StringC &,const StringC &) DocNodeC::GetName(void) const DocNodeC::GetPathName(void) const DocNodeC::AddPage(const StringC &,DocPageC &,int) DocNodeC::CreateHTML(const StringC &,BooleanT) const DocNodeC::GetBriefComment(const StringC &) const DocNodeC::GetDetailComment(const StringC &) const

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

Variables:

DocNodeC()

Default constructor so can use with RCHashARC

DocNodeC & operator=(const DocNodeC & oth)

Assignment operator so can use with RCHashARC

void SetNames(const StringC & name,const StringC & pathName)

Sets the names of a node in the tree

name	page name of this node
pathName	full path name of the page including empty root name

const StringC GetName() const

Access to the name of the node

const StringC GetPathName() const

Access to path name for the page
Strips the empty root name and . from the start

void AddPage(const StringC & fullName,DocPageC & page,int level)

Recursively add a page to the tree

fullName	path name without underscores describing position
page	the page to insert in the tree
level	the current depth in the tree

void CreateHTML(const StringC & projHome,BooleanT develop) const

Recursively creates HTML pages for each node

projHome	project home directory
develop	are these develop pages or not

The develop flag is used to toggle between develop and full pages which changes the colour of the banner as well as where the links go. The position of the pages is determined relative to projHome.

const StringC GetBriefComment(const StringC & ehtHome) const

Scans node's .eht file for brief comment

const StringC GetDetailComment(const StringC & ehtHome) const

Scans node's .eht file for detail comment