diff options
| author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2020-10-22 09:15:03 +0200 |
|---|---|---|
| committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2020-10-27 09:05:31 +0000 |
| commit | d3ee9402ebc0abcf973ea8a7f4268c9f6aacd364 (patch) | |
| tree | 81959ca1a57c8d20b5a93f2ba4d0f82be8c21208 /sources/shiboken2/ApiExtractor/documentation.h | |
| parent | 87b8b73945affdf94c886bf17c43545c0a0d5d89 (diff) | |
shiboken2: Split out class Documentation
It is required for further refactorings.
Change-Id: Ied5c73494546f3345cc76d2c9f1a808b7c5ee1e0
Reviewed-by: Christian Tismer <tismer@stackless.com>
Diffstat (limited to 'sources/shiboken2/ApiExtractor/documentation.h')
| -rw-r--r-- | sources/shiboken2/ApiExtractor/documentation.h | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/sources/shiboken2/ApiExtractor/documentation.h b/sources/shiboken2/ApiExtractor/documentation.h new file mode 100644 index 000000000..b0083c2be --- /dev/null +++ b/sources/shiboken2/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 |