ICompound Class Reference

The interface to a compound in the object model. More...

#include <doxmlintf.h>

Inheritance diagram for ICompound:

Public Types
enum	CompoundKind {   Invalid =0, Class, Struct, Union,   Interface, Protocol, Category, Exception,   File, Namespace, Group, Page,   Example, Dir, Invalid =0, Class,   Struct, Union, Interface, Protocol,   Category, Exception, File, Namespace,   Group, Page, Example, Dir }
enum	CompoundKind {   Invalid =0, Class, Struct, Union,   Interface, Protocol, Category, Exception,   File, Namespace, Group, Page,   Example, Dir, Invalid =0, Class,   Struct, Union, Interface, Protocol,   Category, Exception, File, Namespace,   Group, Page, Example, Dir }

Public Member Functions
virtual const IString *	name () const =0
virtual const IString *	id () const =0
virtual CompoundKind	kind () const =0
virtual const IString *	kindString () const =0
virtual ISectionIterator *	sections () const =0
virtual IDocRoot *	briefDescription () const =0
virtual IDocRoot *	detailedDescription () const =0
virtual IMember *	memberById (const char *id) const =0
virtual IMemberIterator *	memberByName (const char *name) const =0
virtual void	release ()=0
virtual const IString *	name () const =0
virtual const IString *	id () const =0
virtual CompoundKind	kind () const =0
virtual const IString *	kindString () const =0
virtual ISectionIterator *	sections () const =0
virtual IDocRoot *	briefDescription () const =0
virtual IDocRoot *	detailedDescription () const =0
virtual IMember *	memberById (const char *id) const =0
virtual IMemberIterator *	memberByName (const char *name) const =0
virtual void	release ()=0

Detailed Description

The interface to a compound in the object model.

A compound has a name which can be obtained via the name() method and a unique id, which is return via the id() method. A compound consists zero or more members which are grouped into sections. The sections() method can be used to access the individual sections. Alternatively, members can be obtained by name or id. There are different types of compounds. The kind() method returns what kind of compound this is. Depending on the return value one can dynamically cast an interface pointer to an more specialised interface that provides additional methods. Example:

ICompound *comp=...;
if (comp->kind()==ICompound::Class)
{
  IClass *cls = dynamic_cast<IClass*>(comp);
  // use methods of IClass
}

The documentation that is provided by a compound is available via the briefDescription() and detailedDescription() methods. To avoid excessive memory usage, release() should be called (once) on each compound interface pointer that is no longer needed.

Definition at line 868 of file doxmlintf.h.

Member Enumeration Documentation

enum ICompound::CompoundKind

Represents the kind of compounds recognised by doxygen.

Enumerator
Invalid
Class
Struct
Union
Interface
Protocol
Category
Exception
File
Namespace
Group
Page
Example
Dir
Invalid
Class
Struct
Union
Interface
Protocol
Category
Exception
File
Namespace
Group
Page
Example
Dir

Definition at line 873 of file doxmlintf.h.

                      { Invalid=0,
                        Class, Struct, Union, Interface, Protocol, Category,
                        Exception, File, Namespace, Group, Page, Example, Dir
                      };

enum ICompound::CompoundKind

Represents the kind of compounds recognised by doxygen.

Enumerator
Invalid
Class
Struct
Union
Interface
Protocol
Category
Exception
File
Namespace
Group
Page
Example
Dir
Invalid
Class
Struct
Union
Interface
Protocol
Category
Exception
File
Namespace
Group
Page
Example
Dir

Definition at line 873 of file doxmlintf.h.

                      { Invalid=0,
                        Class, Struct, Union, Interface, Protocol, Category,
                        Exception, File, Namespace, Group, Page, Example, Dir
                      };

Member Function Documentation

virtual IDocRoot* ICompound::briefDescription ( ) const

pure virtual

Returns a tree-structured representation of the brief description that is attached to this compound.

Implemented in CompoundHandler.

virtual IDocRoot* ICompound::briefDescription ( ) const

pure virtual

Returns a tree-structured representation of the brief description that is attached to this compound.

Implemented in CompoundHandler.

virtual IDocRoot* ICompound::detailedDescription ( ) const

pure virtual

Returns a tree-structured representation of the detailed description that is attached to this compound.

Implemented in CompoundHandler.

virtual IDocRoot* ICompound::detailedDescription ( ) const

pure virtual

Returns a tree-structured representation of the detailed description that is attached to this compound.

Implemented in CompoundHandler.

virtual const IString* ICompound::id ( ) const

pure virtual

Returns the id of this compound. The id is a unique string representing a specific compound object.

Implemented in CompoundHandler.

virtual const IString* ICompound::id ( ) const

pure virtual

Returns the id of this compound. The id is a unique string representing a specific compound object.

Implemented in CompoundHandler.

virtual CompoundKind ICompound::kind ( ) const

pure virtual

Returns the kind of compound. See CompoundKind for possible values.

Implemented in CompoundHandler.

virtual CompoundKind ICompound::kind ( ) const

pure virtual

Returns the kind of compound. See CompoundKind for possible values.

Implemented in CompoundHandler.

virtual const IString* ICompound::kindString ( ) const

pure virtual

Returns a string representation of the compound kind.

See also

kind()

Implemented in CompoundHandler.

virtual const IString* ICompound::kindString ( ) const

pure virtual

Returns a string representation of the compound kind.

See also

kind()

Implemented in CompoundHandler.

virtual IMember* ICompound::memberById ( const char *  id ) const

pure virtual

Returns an interface to a member given its id.

Parameters

id	The member id.

Implemented in CompoundHandler.

virtual IMember* ICompound::memberById ( const char *  id ) const

pure virtual

Returns an interface to a member given its id.

Parameters

id	The member id.

Implemented in CompoundHandler.

virtual IMemberIterator* ICompound::memberByName ( const char *  name ) const

pure virtual

Returns a list of all members within the compound having a certain name. Member overloading is the reason why there can be more than one member.

Parameters

name	The name of the member.

Implemented in CompoundHandler.

virtual IMemberIterator* ICompound::memberByName ( const char *  name ) const

pure virtual

Returns a list of all members within the compound having a certain name. Member overloading is the reason why there can be more than one member.

Parameters

name	The name of the member.

Implemented in CompoundHandler.

virtual const IString* ICompound::name ( ) const

pure virtual

Returns the name of this compound

Implemented in CompoundHandler.

virtual const IString* ICompound::name ( ) const

pure virtual

Returns the name of this compound

Implemented in CompoundHandler.

virtual void ICompound::release ( )

pure virtual

Decreases the reference counter for this compound. If it reaches zero, the memory for the compound will be released.

Implemented in CompoundHandler.

virtual void ICompound::release ( )

pure virtual

Decreases the reference counter for this compound. If it reaches zero, the memory for the compound will be released.

Implemented in CompoundHandler.

virtual ISectionIterator* ICompound::sections ( ) const

pure virtual

Returns an iterator for the different member sections in this compound.

Implemented in CompoundHandler.

virtual ISectionIterator* ICompound::sections ( ) const

pure virtual

Returns an iterator for the different member sections in this compound.

Implemented in CompoundHandler.

---

The documentation for this class was generated from the following file:

• doxygen-1.8.11/addon/doxmlparser/include/doxmlintf.h