blob: a623529ca35ff98bd8a2c4cab47268b9ed5ef590 (
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
|
// Copyright (C) 2020 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#ifndef DOCUMENTATION_H
#define DOCUMENTATION_H
#include "documentation_enums.h"
#include <QtCore/qstring.h>
#include <QtCore/qcompare.h>
QT_FORWARD_DECLARE_CLASS(QDebug)
class Documentation
{
public:
Documentation() = default;
explicit Documentation(const QString &detailed,
const QString &brief,
const QString &sourceFile,
DocumentationFormat fmt = DocumentationFormat::Native);
bool isEmpty() const;
void setValue(const QString& value, DocumentationType t = DocumentationType::Detailed);
DocumentationFormat format() const;
void setFormat(DocumentationFormat f);
bool equals(const Documentation &rhs) const;
bool hasDetailed() const { return !m_detailed.isEmpty(); }
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);
bool hasSourceFile() const { return !m_sourceFile.isEmpty(); }
const QString &sourceFile() const { return m_sourceFile; }
void setSourceFile(const QString &newSourceFile) { m_sourceFile = newSourceFile; }
private:
friend bool comparesEqual(const Documentation &lhs,
const Documentation &rhs) noexcept
{
return lhs.m_format == rhs.m_format && lhs.m_detailed == rhs.m_detailed
&& lhs.m_brief == rhs.m_brief && lhs.m_sourceFile == rhs.m_sourceFile;
}
Q_DECLARE_EQUALITY_COMPARABLE(Documentation)
QString m_detailed;
QString m_brief;
QString m_sourceFile;
DocumentationFormat m_format = DocumentationFormat::Native;
};
#ifndef QT_NO_DEBUG_STREAM
QDebug operator<<(QDebug debug, const Documentation &);
#endif
#endif // DOCUMENTATION_H
|
