Warning: That file was not part of the compilation database. It may have many parsing errors.

1/****************************************************************************
2**
3** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
4** Contact: http://www.qt-project.org/legal
5**
6** This file is part of the tools applications of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and Digia. For licensing terms and
14** conditions see http://qt.digia.com/licensing. For further information
15** use the contact form at http://qt.digia.com/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 2.1 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 2.1 requirements
23** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
24**
25** In addition, as a special exception, Digia gives you certain additional
26** rights. These rights are described in the Digia Qt LGPL Exception
27** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
28**
29** GNU General Public License Usage
30** Alternatively, this file may be used under the terms of the GNU
31** General Public License version 3.0 as published by the Free Software
32** Foundation and appearing in the file LICENSE.GPL included in the
33** packaging of this file. Please review the following information to
34** ensure the GNU General Public License version 3.0 requirements will be
35** met: http://www.gnu.org/copyleft/gpl.html.
36**
37**
38** $QT_END_LICENSE$
39**
40****************************************************************************/
41
42/*
43 doc.h
44*/
45
46#ifndef DOC_H
47#define DOC_H
48
49#include <QSet>
50#include <QString>
51#include <QMap>
52
53#include "location.h"
54
55QT_BEGIN_NAMESPACE
56
57class Atom;
58class CodeMarker;
59class Config;
60class DocPrivate;
61class Quoter;
62class Text;
63class FakeNode;
64
65typedef QMap<QString, QStringList> QCommandMap;
66typedef QMap<QString, QString> QStringMap;
67typedef QMultiMap<QString, QString> QStringMultiMap;
68
69class Doc
70{
71 public:
72 // the order is important
73 enum Sections {
74 NoSection = -2,
75 Part = -1,
76 Chapter = 1,
77 Section1 = 1,
78 Section2 = 2,
79 Section3 = 3,
80 Section4 = 4
81 };
82
83 Doc() : priv(0) {}
84 Doc(const Location &start_loc,
85 const Location &end_loc,
86 const QString &source,
87 const QSet<QString> &metaCommandSet);
88 Doc(const Doc &doc);
89 ~Doc();
90
91 Doc& operator=( const Doc& doc );
92
93 void renameParameters(const QStringList &oldNames,
94 const QStringList &newNames);
95 void simplifyEnumDoc();
96 void setBody(const Text &body);
97
98 const Location &location() const;
99 bool isEmpty() const;
100 const QString& source() const;
101 const Text& body() const;
102 Text briefText(bool inclusive = false) const;
103 Text trimmedBriefText(const QString &className) const;
104 Text legaleseText() const;
105 const QString& baseName() const;
106 Sections granularity() const;
107 const QSet<QString> &parameterNames() const;
108 const QStringList &enumItemNames() const;
109 const QStringList &omitEnumItemNames() const;
110 const QSet<QString> &metaCommandsUsed() const;
111 QStringList metaCommandArgs( const QString& metaCommand ) const;
112 const QList<Text> &alsoList() const;
113 bool hasTableOfContents() const;
114 bool hasKeywords() const;
115 bool hasTargets() const;
116 const QList<Atom *> &tableOfContents() const;
117 const QList<int> &tableOfContentsLevels() const;
118 const QList<Atom *> &keywords() const;
119 const QList<Atom *> &targets() const;
120 const QStringMultiMap &metaTagMap() const;
121
122 static void initialize( const Config &config );
123 static void terminate();
124 static QString alias( const QString &english );
125 static void trimCStyleComment( Location& location, QString& str );
126 static CodeMarker *quoteFromFile(const Location &location,
127 Quoter &quoter,
128 const QString &fileName);
129 static QString canonicalTitle(const QString &title);
130
131 private:
132 void detach();
133 DocPrivate *priv;
134};
135
136QT_END_NAMESPACE
137
138#endif
139

Warning: That file was not part of the compilation database. It may have many parsing errors.