Public Member Functions | List of all members
IDoxygen Class Referenceabstract

#include <doxmlintf.h>

Inheritance diagram for IDoxygen:
MainHandler

Public Member Functions

virtual ICompoundIterator * compounds () const =0
 
virtual ICompound * compoundById (const char *id) const =0
 
virtual ICompound * compoundByName (const char *name) const =0
 
virtual ICompound * memberById (const char *id) const =0
 
virtual ICompoundIterator * memberByName (const char *name) const =0
 
virtual void release ()=0
 
virtual void setDebugLevel (int level)=0
 
virtual bool readXMLDir (const char *xmlDirName)=0
 
virtual ICompoundIterator * compounds () const =0
 
virtual ICompound * compoundById (const char *id) const =0
 
virtual ICompound * compoundByName (const char *name) const =0
 
virtual ICompound * memberById (const char *id) const =0
 
virtual ICompoundIterator * memberByName (const char *name) const =0
 
virtual void release ()=0
 
virtual void setDebugLevel (int level)=0
 
virtual bool readXMLDir (const char *xmlDirName)=0
 

Detailed Description

Root node of the object model.

Definition at line 1081 of file doxmlintf.h.

Member Function Documentation

virtual ICompound* IDoxygen::compoundById ( const char *  id) const
pure virtual

Returns a compound given its unique id. If you have a compound id this function is much more efficient than iterating over the compound list. Returns 0 if the id is not valid.

Implemented in MainHandler.

virtual ICompound* IDoxygen::compoundById ( const char *  id) const
pure virtual

Returns a compound given its unique id. If you have a compound id this function is much more efficient than iterating over the compound list. Returns 0 if the id is not valid.

Implemented in MainHandler.

virtual ICompound* IDoxygen::compoundByName ( const char *  name) const
pure virtual

Returns a compound given its name (including the scope). Returns 0 if the name is not found in the project.

Implemented in MainHandler.

virtual ICompound* IDoxygen::compoundByName ( const char *  name) const
pure virtual

Returns a compound given its name (including the scope). Returns 0 if the name is not found in the project.

Implemented in MainHandler.

virtual ICompoundIterator* IDoxygen::compounds ( ) const
pure virtual

Returns an iterator that can be used to iterate over the list of compounds found in the project.

Implemented in MainHandler.

virtual ICompoundIterator* IDoxygen::compounds ( ) const
pure virtual

Returns an iterator that can be used to iterate over the list of compounds found in the project.

Implemented in MainHandler.

virtual ICompound* IDoxygen::memberById ( const char *  id) const
pure virtual

Returns an interface to a compound containing a member given it the member's id. Given the ICompound interface one can use the same id to obtain the IMember interface.

Parameters
idThe member id.

Implemented in MainHandler.

virtual ICompound* IDoxygen::memberById ( const char *  id) const
pure virtual

Returns an interface to a compound containing a member given it the member's id. Given the ICompound interface one can use the same id to obtain the IMember interface.

Parameters
idThe member id.

Implemented in MainHandler.

virtual ICompoundIterator* IDoxygen::memberByName ( const char *  name) const
pure virtual

Returns a list of all compounds containing at least one members with a certain name. Each compound can be asked to return the list of members with that name.

Parameters
nameThe name of the member.

Implemented in MainHandler.

virtual ICompoundIterator* IDoxygen::memberByName ( const char *  name) const
pure virtual

Returns a list of all compounds containing at least one members with a certain name. Each compound can be asked to return the list of members with that name.

Parameters
nameThe name of the member.

Implemented in MainHandler.

virtual bool IDoxygen::readXMLDir ( const char *  xmlDirName)
pure virtual

Reads an XML directory produced by doxygen and builds up a data structure representing the contents of the XML files in the directory.

Implemented in MainHandler.

virtual bool IDoxygen::readXMLDir ( const char *  xmlDirName)
pure virtual

Reads an XML directory produced by doxygen and builds up a data structure representing the contents of the XML files in the directory.

Implemented in MainHandler.

virtual void IDoxygen::release ( )
pure virtual

Releases the memory for the object hierarchy obtained by createdObjecModelFromXML(). First release all iterators before calling this function.

Implemented in MainHandler.

virtual void IDoxygen::release ( )
pure virtual

Releases the memory for the object hierarchy obtained by createdObjecModelFromXML(). First release all iterators before calling this function.

Implemented in MainHandler.

virtual void IDoxygen::setDebugLevel ( int  level)
pure virtual

Sets the debug level.

  • 0 all debugging messages are disabled (the default).
  • 1 display important messages only
  • 2 display any messages.

Implemented in MainHandler.

virtual void IDoxygen::setDebugLevel ( int  level)
pure virtual

Sets the debug level.

  • 0 all debugging messages are disabled (the default).
  • 1 display important messages only
  • 2 display any messages.

Implemented in MainHandler.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.11