TOP --> CcDoc
class CCcDocParser

Parse a C++ header file and generate a list of statement tuples.

Author:
Joe Linoff

Version:
$Id: ccdocparser.h,v 1.4 1999/06/12 18:10:33 jdl Exp $

Source:
../../ccdoc/src/ccdocparser.h:29

Constructors Index

CCcDocParser
[public] Default constructor.
~CCcDocParser
[public] Destructor.

Methods Index

GetRootNode
[public] Get the root node of the parse tree for this file. This is always a FILE node.
IsDebug
[public] Is the CCDOC_PARSER_DEBUG environment variable set?
Parse
[public] Parse the pre-processed file.

Constructors

CCcDocParser 

public CCcDocParser ( ) ;

Default constructor.

CCcDocParser 

public ~ CCcDocParser ( ) ;

Destructor.

Methods

Parse 

public bool Parse ( CJdlBufferedFileReader & file ,
                    const char * srcFileName ,
                    const char * pkgName ) ;

Parse the pre-processed file.

Parameters:
file The pre-processed file object.
srcFileName The name of the original source file.
pkgName The default package name.

Return:
True if parsing completed successfully or false otherwise.

GetRootNode 

public CCcDocParserNode * GetRootNode ( ) const ;

Get the root node of the parse tree for this file. This is always a FILE node.

Return:
The root of the parse tree for this file.

IsDebug 

public bool IsDebug ( ) const ;

Is the CCDOC_PARSER_DEBUG environment variable set?

Return:
True if it is set or false otherwise.

This documentation was generated automatically by the ccdoc tool (version 0.7a).
Click here to submit a bug report or feature request.

Click here to return to the top of the page.