Mercurial > projects > qtd

comparison generator/docparser.h @ 1:e78566595089

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
initial import
author mandel
date Mon, 11 May 2009 16:01:50 +0000
parents
children
comparison
equal deleted inserted replaced
0:36fb74dc547d 1:e78566595089
1 /****************************************************************************
2 **
3 ** Copyright (C) 1992-2008 Nokia. All rights reserved.
4 **
5 ** This file is part of Qt Jambi.
6 **
7 ** * Commercial Usage
8 * Licensees holding valid Qt Commercial licenses may use this file in
9 * accordance with the Qt Commercial License Agreement provided with the
10 * Software or, alternatively, in accordance with the terms contained in
11 * a written agreement between you and Nokia.
12 *
13 *
14 * GNU General Public License Usage
15 * Alternatively, this file may be used under the terms of the GNU
16 * General Public License versions 2.0 or 3.0 as published by the Free
17 * Software Foundation and appearing in the file LICENSE.GPL included in
18 * the packaging of this file. Please review the following information
19 * to ensure GNU General Public Licensing requirements will be met:
20 * http://www.fsf.org/licensing/licenses/info/GPLv2.html and
21 * http://www.gnu.org/copyleft/gpl.html. In addition, as a special
22 * exception, Nokia gives you certain additional rights. These rights
23 * are described in the Nokia Qt GPL Exception version 1.2, included in
24 * the file GPL_EXCEPTION.txt in this package.
25 *
26 * Qt for Windows(R) Licensees
27 * As a special exception, Nokia, as the sole copyright holder for Qt
28 * Designer, grants users of the Qt/Eclipse Integration plug-in the
29 * right for the Qt/Eclipse Integration to link to functionality
30 * provided by Qt Designer and its related libraries.
31 *
32 *
33 * If you are unsure which license is appropriate for your use, please
34 * contact the sales department at qt-sales@nokia.com.
35
36 **
37 ** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
38 ** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
39 **
40 ****************************************************************************/
41
42 #ifndef DOCPARSER_H
43 #define DOCPARSER_H
44
45 #include <QtCore/QString>
46
47
48 class AbstractMetaClass;
49 class AbstractMetaFunction;
50 class AbstractMetaEnum;
51 class AbstractMetaEnumValue;
52 class QDomDocument;
53
54 class DocParser
55 {
56 public:
57 DocParser(const QString &docFile);
58 ~DocParser();
59
60 QString documentation(const AbstractMetaClass *meta_class) const;
61 QString documentation(const AbstractMetaEnum *meta_enum) const;
62 QString documentation(const AbstractMetaEnumValue *meta_enum) const;
63 QString documentationForFunction(const QString &signature) const;
64 QString documentationForSignal(const QString &signature) const;
65
66 private:
67 QString documentationForFunction(const QString &signature, const QString &tag) const;
68 void build();
69
70 QString m_doc_file;
71 QDomDocument *m_dom;
72 };
73
74 #endif // DOCPARSER_H