Developer Documentation
RAVL, Recognition And Vision Library
USER HOME PAGE CLASS LIST CONTENTS
Ravl - Source Tools - CxxDoc - Internal - CommentInfoC
 

  PUBLIC
CommentInfoC::CommentInfoC(void)
CommentInfoC::Text(void)
CommentInfoC::Header(void)
CommentInfoC::Text(void) const
CommentInfoC::Header(void) const
CommentInfoC::Var(const StringC &)
CommentInfoC::Var(const StringC &) const
CommentInfoC::SetVar(const StringC &,const StringC &)
CommentInfoC::Vars(void)
CommentInfoC::Vars(void) const
CommentInfoC::Locals(void)
CommentInfoC::Locals(void) const
CommentInfoC::Reset(void)
CommentInfoC::FileReset(void)

   CommentInfoC   
 
Generate a full path name, with template paramiter subs. Class containing comment info.
 
include "Ravl/CxxDoc/Object.hh"
Created:08/12/1999 
Source file:Ravl/SourceTools/CxxDoc/Object.hh
User Level:Normal
Library:RavlCxxDoc
In Scope:RavlCxxDocN

Variables:
StringC text;

StringC header;

HashC vars;

RCHashC locals;

Methods:
CommentInfoC()
Default constructor.

StringC & Text()
Access text of comment.
Access the text or detailed comment.

StringC & Header()
Access header of comment.
Access the header or brief comment.

const StringC & Text() const
Access text of comment.
Access the text or detailed comment.

const StringC & Header() const
Access header of comment.
Access the header or brief comment.

StringC & Var(const StringC & nm)
Access a global variable.
Creates a new entry in the table if not found.

StringC Var(const StringC & nm) const
Access a global variable
Returns an empty string if its not found.

void SetVar(const StringC & nm,const StringC & value)
Set a global variable.

HashC<StringC,StringC> & Vars()
Access global variable table.

const HashC<StringC,StringC> & Vars() const
Access global variable table.

RCHashC<StringC,StringC> & Locals()
Access local variable table.

const RCHashC<StringC,StringC> & Locals() const
Access local variable table.

void Reset()
Reset comment.
Used to reset comments between language elements in a file.

void FileReset()
Reset comment and local variables.
Used to reset comments on the start of processing a new file. This removes all gobal variables as well as local ones.


Maintainer:Charles Galambos, Created: 08/12/1999, Documentation by CxxDoc: Tue Aug 13 09:59:30 2002