aboutsummaryrefslogtreecommitdiffstats
path: root/sources/shiboken6/ApiExtractor/documentation.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'sources/shiboken6/ApiExtractor/documentation.cpp')
-rw-r--r--sources/shiboken6/ApiExtractor/documentation.cpp88
1 files changed, 40 insertions, 48 deletions
diff --git a/sources/shiboken6/ApiExtractor/documentation.cpp b/sources/shiboken6/ApiExtractor/documentation.cpp
index c042b3b8a..33cf0e9fb 100644
--- a/sources/shiboken6/ApiExtractor/documentation.cpp
+++ b/sources/shiboken6/ApiExtractor/documentation.cpp
@@ -1,73 +1,65 @@
-/****************************************************************************
-**
-** 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$
-**
-****************************************************************************/
+// Copyright (C) 2020 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#include "documentation.h"
-Documentation::Documentation(const QString &value, Documentation::Type t, Documentation::Format fmt)
+#include <QtCore/QDebug>
+
+Documentation::Documentation(const QString &detailed,
+ const QString &brief,
+ Format fmt) :
+ m_detailed(detailed.trimmed()), m_brief(brief.trimmed()), m_format(fmt)
{
- setValue(value, t, fmt);
}
bool Documentation::isEmpty() const
{
- for (int i = 0; i < Type::Last; i++) {
- if (!m_data.value(static_cast<Type>(i)).isEmpty())
- return false;
- }
- return true;
+ return m_detailed.isEmpty() && m_brief.isEmpty();
}
-QString Documentation::value(Documentation::Type t) const
+Documentation::Format Documentation::format() const
{
- return m_data.value(t);
+ return m_format;
}
-void Documentation::setValue(const QString &value, Documentation::Type t, Documentation::Format fmt)
+void Documentation::setValue(const QString &value, Documentation::Type t)
{
- const QString v = value.trimmed();
- if (v.isEmpty())
- m_data.remove(t);
+ if (t == Brief)
+ setBrief(value);
else
- m_data[t] = value.trimmed();
- m_format = fmt;
+ setDetailed(value);
}
-Documentation::Format Documentation::format() const
+void Documentation::setFormat(Documentation::Format f)
{
- return m_format;
+ m_format = f;
}
-void Documentation::setFormat(Documentation::Format f)
+void Documentation::setDetailed(const QString &detailed)
{
- m_format = f;
+ m_detailed = detailed.trimmed();
}
-bool Documentation::equals(const Documentation &rhs) const
+void Documentation::setBrief(const QString &brief)
{
- return m_format == rhs.m_format && m_data == rhs.m_data;
+ m_brief = brief.trimmed();
+}
+
+#ifndef QT_NO_DEBUG_STREAM
+QDebug operator<<(QDebug debug, const Documentation &d)
+{
+ QDebugStateSaver saver(debug);
+ debug.noquote();
+ debug.nospace();
+ debug << "Documentation(";
+ if (!d.isEmpty()) {
+ debug << "format=" << d.format();
+ if (!d.brief().isEmpty())
+ debug << ", brief=\"" << d.brief() << '"';
+ if (!d.detailed().isEmpty())
+ debug << ", detailed=\"" << d.detailed() << '"';
+ }
+ debug << ')';
+ return debug;
}
+#endif // QT_NO_DEBUG_STREAM