doxmlintf.h File Reference

The interface to the object model provided by the XML parser library. More...

Go to the source code of this file.

Classes
class	IString
	Read only interface to a string. More...
class	ILinkedText
	Base interface for hyperlinked text. More...
class	ILT_Text
	Plain text fragment. More...
class	ILT_Ref
	Reference to an object. More...
class	ILinkedTextIterator
	Iterates over a list of ILinkedText fragments. More...
class	IParam
	Representation of a parameter of a function. More...
class	IParamIterator
class	IMemberReference
class	IMemberReferenceIterator
class	IDoc
class	IDocMarkup
class	IDocPara
class	IDocText
class	IDocMarkupModifier
class	IDocItemizedList
class	IDocOrderedList
class	IDocListItem
class	IDocParameterList
class	IDocParameterItem
class	IDocParameter
class	IDocTitle
class	IDocSimpleSect
class	IDocRef
class	IDocVariableList
class	IDocVariableListEntry
class	IDocHRuler
class	IDocLineBreak
class	IDocULink
class	IDocEMail
class	IDocLink
class	IDocProgramListing
class	IDocCodeLine
class	IDocHighlight
class	IDocFormula
class	IDocImage
class	IDocDotFile
class	IDocIndexEntry
class	IDocTable
class	IDocRow
class	IDocEntry
class	IDocSection
class	IDocInternal
class	IDocTocList
class	IDocTocItem
class	IDocCopy
class	IDocVerbatim
class	IDocAnchor
class	IDocSymbol
class	IDocRoot
class	IDocIterator
class	IEdgeLabel
class	IEdgeLabelIterator
class	IChildNode
class	IChildNodeIterator
class	INode
class	INodeIterator
class	IGraph
class	IMember
class	IDefine
class	IProperty
class	IVariable
class	ITypedef
class	IFunction
class	ISignal
class	IPrototype
class	IFriend
class	IDCOP
class	ISlot
class	IEnumValue
class	IInclude
	Include relation. More...
class	IIncludeIterator
class	IMemberIterator
class	IEnum
class	ISection
	The interface to a section in the object model. More...
class	IUserDefined
class	ISectionIterator
class	ICompound
	The interface to a compound in the object model. More...
class	ICompoundIterator
class	IRelatedCompound
class	IRelatedCompoundIterator
class	IClass
	The interface to a class in the object model. More...
class	IStruct
	The interface to a struct in the object model. More...
class	IUnion
	The interface to a union in the object model. More...
class	IInterface
	The interface to a Java/IDL interface in the object model. More...
class	IException
	The interface to a Java/IDL exception in the object model. More...
class	INamespace
	The interface to a namespace in the object model. More...
class	IFile
	The interface to a file in the object model. More...
class	IGroup
	The interface to a group in the object model. More...
class	IPage
	The interface to a page in the object model. More...
class	IDir
	Interface to a directory in the object model. More...
class	IDoxygen

Macros
#define	VIRTUAL_DESTRUCTOR(x)   virtual ~x() {}

Functions
IDoxygen *	createObjectModel ()

Detailed Description

The interface to the object model provided by the XML parser library.

To start using this library one calls createObjectModel() and then uses the returned IDoxygen interface to read doxygen generated XML output and navigate through the information contained in it.

See also

createObjectModel()

Definition in file doxmlintf.h.

Macro Definition Documentation

#define VIRTUAL_DESTRUCTOR

(

x

)

virtual ~x() {}

Definition at line 38 of file doxmlintf.h.

Function Documentation

IDoxygen* createObjectModel

(

)

Factory method that creates an empty object model for a doxygen generated XML file. Use the readXMLDir() method to build the model from an XML output directory containing doxygen output.

Definition at line 273 of file mainhandler.cpp.

{
  compoundhandler_init();
  sectionhandler_init();
  memberhandler_init();
  dochandler_init();
  graphhandler_init();
  return new MainHandler;
}