User Documentation
RAVL, Recognition And Vision Library
DEVELOP HOME PAGE CLASS LIST CONTENTS
 

namespace RavlCxxDocN
C++ parser's namespace.

Created: 08/12/1999
User Level:Normal
Library: RavlCxxDoc

Comments:

This namespace contains the classes that make up the parser, the parse tree and the C++ documenation system.

Child Classes:

#include "Ravl/CxxDoc/Object.hh"

ObjectC Ya basic object.
ObjectListC Object list
#include "Ravl/CxxDoc/CxxElements.hh"

DerivedC Derivedd object. like a class, struct, or namespace.
ClassTemplateC Templated class.
MethodTemplateC Templated function.
#include "Ravl/CxxDoc/Object.hh"

DesciptionGeneratorC Description generator.
CommentInfoC Generate a full path name, with template paramiter subs. Class containing comment info.
#include "Ravl/CxxDoc/Document.hh"

DocumentC Documentor
#include "Ravl/CxxDoc/CxxScope.hh"

ScopeC Scoped object. like a class, struct, or namespace.
InheritIterC Iterator through all objects in the inheritance hirachy.
#include "Ravl/CxxDoc/CxxElements.hh"

DataTypeC DataTyped object. like a class, struct, or namespace.
ClassC Class storage object.
MethodC Methodd object.
TypedefC Typedefd object. like a class, struct, or namespace.
VariableC Variabled object. like a class, struct, or namespace.
MarkerC Markerd object. like a class, struct, or namespace.
InheritC Inheritd object. like a class, struct, or namespace.
EnumC Enumd object. like a class, struct, or namespace.
#include "Ravl/CxxDoc/Parser.hh"

ParserC C++ File Parser
#include "Ravl/CxxDoc/DocNode.hh"

DocNodeC Doc node.
#include "Ravl/CxxDoc/DocTree.hh"
DocTreeC Documentation tree body.
Enumerated types:

#include "Ravl/CxxDoc/Object.hh"
enum ScopeAccessT { SAPrivate, SAPublic, SAProtected } ;
Description generator.
This class is used to control the text generated by various functions in C++ class tree.

Methods:
StringC PathName(DListC<ObjectC> path,DesciptionGeneratorC & dg = defaultDescGen,int maxDepth = 60)
Generate a full path name.

StringC PathName(DListC<ObjectC> path,HashC<StringC,StringC> & templSub,DesciptionGeneratorC & dg = defaultDescGen,int maxDepth = 30)
Generate a full path name, with template paramiter subs. Class containing comment info.


Documentation by CxxDoc: Tue Aug 13 09:59:28 2002