aboutsummaryrefslogtreecommitdiffstats
path: root/sources/shiboken6/ApiExtractor/documentation.h
diff options
context:
space:
mode:
Diffstat (limited to 'sources/shiboken6/ApiExtractor/documentation.h')
-rw-r--r--sources/shiboken6/ApiExtractor/documentation.h73
1 files changed, 73 insertions, 0 deletions
diff --git a/sources/shiboken6/ApiExtractor/documentation.h b/sources/shiboken6/ApiExtractor/documentation.h
new file mode 100644
index 000000000..b0083c2be
--- /dev/null
+++ b/sources/shiboken6/ApiExtractor/documentation.h
@@ -0,0 +1,73 @@
+/****************************************************************************
+**
+** 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/QMap>
+#include <QtCore/QString>
+
+class Documentation
+{
+public:
+ enum Format {
+ Native,
+ Target
+ };
+ enum Type {
+ Detailed,
+ Brief,
+ Last
+ };
+
+ Documentation() = default;
+ Documentation(const QString& value, Type t = Documentation::Detailed,
+ Format fmt = Documentation::Native);
+
+ bool isEmpty() const;
+
+ QString value(Type t = Documentation::Detailed) const;
+ void setValue(const QString& value, Type t = Documentation::Detailed,
+ Format fmt = Documentation::Native);
+
+ Documentation::Format format() const;
+ void setFormat(Format f);
+
+ bool equals(const Documentation &rhs) const;
+
+private:
+ QMap<Type, QString> m_data;
+ 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); }
+
+#endif // DOCUMENTATION_H