doxmlintf.h

doxygen(一个自动从源代码生成文档的工具)的源代码

#ifndef _DOXMLINTF_H
#define _DOXMLINTF_H

#include <qlist.h>
#include <qstring.h>

class IParam
{
  public:
    virtual QString type() const = 0;
    virtual QString declarationName() const = 0;
    virtual QString definitionName() const = 0;
    virtual QString attrib() const = 0;
    virtual QString arraySpecifier() const = 0;
    virtual QString defaultValue() const = 0;
};

class IMember
{
  public:
    virtual QString kind() const = 0;
    virtual QString id() const = 0;
    virtual QString protection() const = 0;
    virtual QString virtualness() const = 0;
    virtual QString type() const = 0;
    virtual QString name() const = 0;
    virtual QListIterator<IParam> getParamIterator() const = 0;
};

class ISection
{
  public:
    virtual QString kind() const = 0;
    virtual QListIterator<IMember> getMemberIterator() const = 0;
};

class ICompound
{
  public:
    virtual QString name() const = 0;
    virtual QString id()   const = 0;
    virtual QString kind() const = 0;
    virtual QListIterator<ISection> getSectionIterator() const = 0;
};

/*! Root node of the object model. */
class IDoxygen
{
  public:
    /*! Returns an iterator that can be used to iterate over the list
     *  of compounds found in the project.
     */
    virtual QListIterator<ICompound> getCompoundIterator() const = 0;

    /*! Returns a compound given its unique \a 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.
     */
    virtual ICompound *getCompoundById(const QString &id) const = 0;

    /*! Returns a compound given its name (including the scope). 
     *  Returns 0 if the name is not found in the project.
     */
    virtual ICompound *getCompoundByName(const QString &name) const = 0;

    virtual IMember *getMemberById(const QString &id) const = 0;
    virtual QList<IMember> *getMemberByName(const QString &name) const = 0;
};

/*! Factory method that creates an object model given an XML file generated
 *  by doxygen.
 *  @param xmlFileName The name of the XML to parse.
 *  @returns An iterface to the object model.
 */
IDoxygen *createObjectModelFromXML(const char *xmlFileName);

#endif