KDevelop API Documentation

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>

Collaboration diagram for DoxyDoc:

Collaboration graph
[legend]
List of all members.

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< QDirm_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

DoxyDoc::DoxyDoc const QStringList dir  ) 
 

Constructs a new DoxyDoc object.

Parameters:
dir all directories, which should be searched for files containing the Doxygen-documentation.

Definition at line 25 of file doxydoc.cpp.

References m_dirs.

DoxyDoc::~DoxyDoc  )  [inline]
 

Definition at line 32 of file doxydoc.h.


Member Function Documentation

void DoxyDoc::formatType QString type  )  [static, private]
 

Definition at line 21 of file doxydoc.cpp.

Referenced by functionDescription().

QString DoxyDoc::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.

Parameters:
scope Scope of the function (e.g. name of class, it is member of, namespace etc ...)
name Name of the function(just the name, no '(' etc. )
type Return-type of the function
arguments String containing the arguments of the function, separated by commas and _without_ the argument names

Definition at line 31 of file doxydoc.cpp.

References formatType(), m_dirs, m_file, and m_list.

Referenced by TagCreator::parseFunctionDeclaration(), and TagCreator::parseFunctionDefinition().


Member Data Documentation

std::list<QDir> DoxyDoc::m_dirs [private]
 

Definition at line 49 of file doxydoc.h.

Referenced by DoxyDoc(), and functionDescription().

QFile DoxyDoc::m_file [private]
 

Definition at line 51 of file doxydoc.h.

Referenced by functionDescription().

QDomNodeList DoxyDoc::m_list [private]
 

Definition at line 52 of file doxydoc.h.

Referenced by functionDescription().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for KDevelop Version 3.1.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Tue Feb 22 09:41:32 2005 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003