User Documentation
RAVL, Recognition And Vision Library
DEVELOP HOME PAGE CLASS LIST CONTENTS
Ravl - Source Tools - CxxDoc - Internal - DocTreeBodyC
 

  PUBLIC
DocTreeBodyC::DocTreeBodyC(void)
DocTreeBodyC::DocTreeBodyC(const StringC &)
DocTreeBodyC::ReadDocentries(const StringC &)
DocTreeBodyC::ReadEHT(const StringC &)
DocTreeBodyC::ReadHTML(const StringC &)
DocTreeBodyC::ReadEHTSet(const StringC &)
DocTreeBodyC::InsertDocLeaf(DListC &,const StringC &,const StringC &,const StringC &,const StringC &,const StringC &,const StringC &)
DocTreeBodyC::InsertDocLeaf(const StringC &,const StringC &,const StringC &,const StringC &,const StringC &,const StringC &)
DocTreeBodyC::Root(void)
DocTreeBodyC::Dump(ostream &)
RCBodyC::References(void) const
RCBodyC::Copy(void) const
RCBodyC::DeepCopy(UIntT) const
RCBodyC::IncRefCounter(void)
RCBodyC::DecRefCounter(void)

   DocTreeBodyC   
 
Documentation tree body.
 
include "Ravl/CxxDoc/DocTree.hh"
Created:17/08/2000 
User Level:Develop
Library:RavlCxxDoc
In Scope:RavlCxxDocN

Parent Classes: Variables:
Methods:
DocTreeBodyC()
Default constructor.

DocTreeBodyC(const StringC & nProjName)
Constructor.

bool ReadDocentries(const StringC & fn)
Read a docentries file.
This creates the appropriate doc node structure.

bool ReadEHT(const StringC & fn)
Read a EHT file.
Puts information into the appropriate node.

bool ReadHTML(const StringC & fn)
Read a HTML file.
Puts information into the appropriate node.

bool ReadEHTSet(const StringC & dir)
Read a set of EHT files from a directory.

bool InsertDocLeaf(DListC<StringC> & node,const StringC & pos,const StringC & nm,const StringC & userlevel,const StringC & brief,const StringC & docFilename,const StringC & nodeType = StringC ("class"))
Insert a documentation leaf into the tree.
Note: If the path 'node' doesn't contain the project name 'projName' it will be added both to the path and to 'pos' before its used.

bool InsertDocLeaf(const StringC & node,const StringC & nm,const StringC & userlevel,const StringC & brief,const StringC & docFilename,const StringC & nodeType = StringC ("class"))
Insert a documentation leaf into the tree.

DocNodeC & Root()
Root of docnode tree.

void Dump(ostream & out)
Dump tree to ostream.

#include "Ravl/RefCounter.hh"
UIntT References() const
Access count of handles open to this object.

RCBodyC & Copy() const
Make copy of body.
This should be provided in derived classes. this funtion will issue an assertion failure if called.

RCBodyC & DeepCopy(UIntT levels = ((UIntT))) const
Make a deep copy of body.
This should be provided in derived classes. this funtion will issue an assertion failure if called.

void IncRefCounter()
Increment reference counter.

bool DecRefCounter()
Decrement reference counter.


Maintainer:Charles Galambos, Created: 17/08/2000, Documentation by CxxDoc: Tue Aug 13 09:59:02 2002