blob: 1769bc071b97b373e045ac615602926c3c579689 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
/****************************************************************************
**
** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt for Python.
**
** $QT_BEGIN_LICENSE:GPL-EXCEPT$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#ifndef DOCUMENTATION_H
#define DOCUMENTATION_H
#include <QtCore/QString>
QT_FORWARD_DECLARE_CLASS(QDebug)
class Documentation
{
public:
enum Format {
Native, // XML
Target // RST
};
enum Type {
Detailed,
Brief,
Last
};
Documentation() = default;
explicit Documentation(const QString &detailed,
const QString &brief,
Format fmt = Documentation::Native);
bool isEmpty() const;
void setValue(const QString& value, Type t = Documentation::Detailed);
Documentation::Format format() const;
void setFormat(Format f);
bool equals(const Documentation &rhs) const;
const QString &detailed() const { return m_detailed; }
void setDetailed(const QString &detailed);
bool hasBrief() const { return !m_brief.isEmpty(); }
const QString &brief() const { return m_brief; }
void setBrief(const QString &brief);
private:
QString m_detailed;
QString m_brief;
Format m_format = Documentation::Native;
};
inline bool operator==(const Documentation &d1, const Documentation &d2)
{ return d1.equals(d2); }
inline bool operator!=(const Documentation &d1, const Documentation &d2)
{ return !d1.equals(d2); }
#ifndef QT_NO_DEBUG_STREAM
QDebug operator<<(QDebug debug, const Documentation &);
#endif
#endif // DOCUMENTATION_H
|
