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

  PUBLIC
DocTreeC::DocTreeC(void)
DocTreeC::DocTreeC(const StringC &)
DocTreeC::ReadDocentries(const StringC &)
DocTreeC::ReadEHT(const StringC &)
DocTreeC::ReadHTML(const StringC &)
DocTreeC::ReadEHTSet(const StringC &)
DocTreeC::InsertDocLeaf(const StringC &,const StringC &,const StringC &,const StringC &,const StringC &,const StringC &)
DocTreeC::InsertDocLeaf(DListC &,const StringC &,const StringC &,const StringC &,const StringC &,const StringC &,const StringC &)
DocTreeC::Root(void)
DocTreeC::Dump(ostream &)
RCHandleC::operator =(const RCHandleC &)
RCHandleC::DeepCopy(UIntT) const
RCHandleC::operator ==(const RCHandleC &) const
RCHandleC::operator !=(const RCHandleC &) const
RCHandleC::Hash(void) const
RCHandleC::IsValid(void) const
RCHandleC::Invalidate(void)
RCHandleC::IsHandleType(const DT &) const
RCHandleC::CheckHandleType(const DT &) const
RCHandleC::References(void) const
RCHandleC::operator <<(ostream &,const RCHandleC &)
RCHandleC::operator >>(istream &,RCHandleC &)

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

Parent Classes: Methods:
DocTreeC()
Default constructor.
creates an invalid handle.

DocTreeC(const StringC & projName)
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 doc node file.
Puts information into the appropriate node.

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

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.

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.

DocNodeC & Root()
Root of docnode tree.

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

#include "Ravl/RefCounter.hh"
const RCHandleC<DocTreeBodyC> & operator =(const RCHandleC<DocTreeBodyC> & oth)
Assign handle.

RCHandleC<DocTreeBodyC> DeepCopy(UIntT levels = ((UIntT))) const
Do a deep copy of the object.

bool operator ==(const RCHandleC<DocTreeBodyC> & oth) const
Are handles to the same object ?

bool operator !=(const RCHandleC<DocTreeBodyC> & oth) const
Are handles to different objects ?

UIntT Hash() const
Default hash function.
This hashes on the address of the body.

bool IsValid() const
Test if this is a valid handle.

void Invalidate()
Invalidate this handle.
Unattaches the body from the handle.

bool IsHandleType(const DT &) const
Is handle of given type ?

void CheckHandleType(const DT & dummy) const
Check handle type. Throw an expception if not.

UIntT References() const
Find the number of references to the body of this object.

ostream & operator <<(ostream & strm,const RCHandleC<DocTreeBodyC> & obj)

istream & operator >>(istream & strm,RCHandleC<DocTreeBodyC> & obj)


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