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
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
|
/****************************************************************************
**
** 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;
};
struct QtXmlToSphinxLink
{
enum Type
{
Method = 0x1, Function = 0x2,
FunctionMask = Method | Function,
Class = 0x4, Attribute = 0x8, Module = 0x10,
Reference = 0x20, External= 0x40
};
enum Flags { InsideBold = 0x1, InsideItalic = 0x2 };
explicit QtXmlToSphinxLink(const QString &ref) : linkRef(ref) {}
QString linkRef;
QString linkText;
Type type = Reference;
int flags = 0;
};
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 QtXmlToSphinxLink resolveLink(const QtXmlToSphinxLink &) const = 0;
virtual ~QtXmlToSphinxDocGeneratorInterface() = default;
};
#endif // QTXMLTOSPHINXINTERFACE_H
|
