diff options
author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2020-12-11 16:16:02 +0100 |
---|---|---|
committer | Qt Cherry-pick Bot <cherrypick_bot@qt-project.org> | 2020-12-15 16:21:32 +0000 |
commit | 29287d7db849688231a0fc9cc49afce4088cf3e2 (patch) | |
tree | fd06c6934b93a07972bd11937a2403c98dbd981c /sources/shiboken6/generator/qtdoc/qtxmltosphinxinterface.h | |
parent | 4df45fc227fdf07c965f26af086aa99a098e46b3 (diff) |
Shiboken6: Decouple QtXmlToSphinx from the doc generator
To enable testing, decouple QtXmlToSphinx from the doc generator
by introducing a parameter struct QtXmlToSphinxParameters
and an interface QtXmlToSphinxDocGeneratorInterface.
Move the messages back into qtxmltosphinx.cpp and move the helper
function convertToRst to the doc generator since it uses FileOut.
Change-Id: I176888dcbd65003856ea8797a5629949598801d5
Reviewed-by: Christian Tismer <tismer@stackless.com>
(cherry picked from commit cddc4e975398c7c285b0dfada8a57fe997f05833)
Reviewed-by: Qt Cherry-pick Bot <cherrypick_bot@qt-project.org>
Diffstat (limited to 'sources/shiboken6/generator/qtdoc/qtxmltosphinxinterface.h')
-rw-r--r-- | sources/shiboken6/generator/qtdoc/qtxmltosphinxinterface.h | 60 |
1 files changed, 60 insertions, 0 deletions
diff --git a/sources/shiboken6/generator/qtdoc/qtxmltosphinxinterface.h b/sources/shiboken6/generator/qtdoc/qtxmltosphinxinterface.h new file mode 100644 index 000000000..c4bdedd21 --- /dev/null +++ b/sources/shiboken6/generator/qtdoc/qtxmltosphinxinterface.h @@ -0,0 +1,60 @@ +/**************************************************************************** +** +** 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 QTXMLTOSPHINXINTERFACE_H +#define QTXMLTOSPHINXINTERFACE_H + +#include <QtCore/QStringList> + +QT_FORWARD_DECLARE_CLASS(QLoggingCategory) + +struct QtXmlToSphinxParameters +{ + QString moduleName; + QString docDataDir; + QString outputDirectory; + QString libSourceDir; + QStringList codeSnippetDirs; + bool snippetComparison = false; +}; + +class QtXmlToSphinxDocGeneratorInterface +{ +public: + virtual QString expandFunction(const QString &function) const = 0; + virtual QString expandClass(const QString &context, + const QString &name) const = 0; + virtual QString resolveContextForMethod(const QString &context, + const QString &methodName) const = 0; + + virtual const QLoggingCategory &loggingCategory() const = 0; + + virtual ~QtXmlToSphinxDocGeneratorInterface() = default; +}; + +#endif // QTXMLTOSPHINXINTERFACE_H |