← Back to branch summary

~ubuntu-branches/debian/sid/kdevelop/sid

« back to all changes in this revision

Viewing changes to languages/cpp/doxydoc.h

  • Committer: Bazaar Package Importer
  • Author(s): Jeremy Lainé
  • Date: 2010-05-05 07:21:55 UTC
  • mfrom: (1.2.3 upstream) (5.1.2 squeeze)
  • Revision ID: james.westby@ubuntu.com-20100505072155-h78lx19pu04sbhtn
Tags: 4:4.0.0-2
http://bugs.debian.org/579947
http://bugs.debian.org/481832
http://bugs.debian.org/562410
http://bugs.debian.org/546961
* Upload to unstable (Closes: #579947, #481832).
* Acknowledge obsolete NMU fixes (Closes: #562410, #546961).

Show diffs side-by-side

added added

removed removed

Lines of Context:
languages/cpp/doxydoc.h
1
 
/***************************************************************************
2
 
*   Copyright (C) 2003 by Jonas B. Jacobi                                 *
3
 
*   j.jacobi@gmx.de                                                       *
4
 
*                                                                         *
5
 
*   This program is free software; you can redistribute it and/or modify  *
6
 
*   it under the terms of the GNU General Public License as published by  *
7
 
*   the Free Software Foundation; either version 2 of the License, or     *
8
 
*   (at your option) any later version.                                   *
9
 
***************************************************************************/
10
 
#ifndef DOXYDOC_H
11
 
#define DOXYDOC_H
12
 
 
13
 
#include <qstring.h>
14
 
#include <qdom.h>
15
 
#include <qdir.h>
16
 
#include <qfile.h>
17
 
#include <list>
18
 
 
19
 
/**
20
 
This class is used for getting the description on functions, stored in xml files, which are created by Doxygen
21
 
@author Jonas B. Jacobi
22
 
@version 0.1
23
 
*/
24
 
class DoxyDoc
25
 
{
26
 
public:
27
 
        /**
28
 
                Constructs a new DoxyDoc object.
29
 
                @param dir all directories, which should be searched for files containing the Doxygen-documentation.
30
 
        */
31
 
        DoxyDoc( const QStringList& dir );
32
 
        ~DoxyDoc()
33
 
        {}
34
 
        ;
35
 
        /**
36
 
                Get the documentation referring to a special function, therefor most parts of the functions signature have to be provided
37
 
                @param scope Scope of the function (e.g. name of class, it is member of, namespace etc ...)
38
 
                @param name Name of the function(just the name, no '(' etc. )
39
 
                @param type Return-type of the function
40
 
                @param arguments String containing the arguments of the function, separated by commas and _without_ the argument names
41
 
        */
42
 
        QString functionDescription( const QString& scope, const QString& name, const QString& type, const QString& arguments );
43
 
        /*not implemented yet, maybe later, if they are useful
44
 
        QString classDescription();
45
 
        QString enumDescription();
46
 
        QString namespaceDescription();
47
 
        QString memberVarDescription();
48
 
        */
49
 
private:
50
 
        static void formatType( QString& type );
51
 
        std::list<QDir> m_dirs;
52
 
        //used for temporary storing/performance reasons
53
 
        QFile m_file;
54
 
        QDomNodeList m_list;
55
 
};
56
 
 
57
 
#endif 
58
 
// kate: indent-mode csands; tab-width 4;
59