DoxyDoc Class Reference
This class is used for getting the description on functions, stored in xml files, which are created by Doxygen. More...
#include <doxydoc.h>
Public Member Functions | |
DoxyDoc (const QStringList &dir) | |
Constructs a new DoxyDoc object. | |
~DoxyDoc () | |
QString | functionDescription (const QString &scope, const QString &name, const QString &type, const QString &arguments) |
Get the documentation referring to a special function, therefor most parts of the functions signature have to be provided. | |
Static Private Member Functions | |
void | formatType (QString &type) |
Private Attributes | |
std::list< QDir > | m_dirs |
QFile | m_file |
QDomNodeList | m_list |
Detailed Description
This class is used for getting the description on functions, stored in xml files, which are created by Doxygen.
- Author:
- Jonas B. Jacobi
- Version:
- 0.1
Definition at line 24 of file doxydoc.h.
Constructor & Destructor Documentation
|
Constructs a new DoxyDoc object.
Definition at line 25 of file doxydoc.cpp. References DoxyDoc(), and m_dirs. Referenced by DoxyDoc(). |
|
|
Member Function Documentation
|
Definition at line 21 of file doxydoc.cpp. References formatType(). Referenced by formatType(), and functionDescription(). |
|
Get the documentation referring to a special function, therefor most parts of the functions signature have to be provided.
Definition at line 31 of file doxydoc.cpp. References formatType(), functionDescription(), m_dirs, m_file, and m_list. Referenced by functionDescription(), TagCreator::parseFunctionDeclaration(), and TagCreator::parseFunctionDefinition(). |
Member Data Documentation
|
Definition at line 49 of file doxydoc.h. Referenced by DoxyDoc(), and functionDescription(). |
|
Definition at line 51 of file doxydoc.h. Referenced by functionDescription(). |
|
Definition at line 52 of file doxydoc.h. Referenced by functionDescription(). |
The documentation for this class was generated from the following files:
- languages/cpp/doxydoc.h
- languages/cpp/doxydoc.cpp