blob: d47101389b0d7eff6f382e981c8b0d8efe574af2 (
plain)
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) 2021 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#ifndef CLASSDOCUMENTATION_H
#define CLASSDOCUMENTATION_H
#include <QtCore/QStringList>
#include <optional>
QT_FORWARD_DECLARE_CLASS(QDebug)
/// An enumeration in a WebXML/doxygen document
struct EnumDocumentation
{
QString name;
QString description;
};
/// A QObject property in a WebXML/doxygen document
struct PropertyDocumentation
{
QString name;
QString brief;
QString description;
};
/// Helper struct for querying a function in a WebXML/doxygen document
struct FunctionDocumentationQuery
{
QString name;
QStringList parameters;
bool constant = false;
};
/// A function in a WebXML/doxygen document
struct FunctionDocumentation : public FunctionDocumentationQuery
{
QString signature;
QString returnType;
QString description;
};
using FunctionDocumentationList = QList<FunctionDocumentation>;
/// A WebXML/doxygen document
struct ClassDocumentation
{
enum Type {
Class, // <class>, class/namespace
Header // <header>, grouped global functions/enums
};
qsizetype indexOfEnum(const QString &name) const;
FunctionDocumentationList findFunctionCandidates(const QString &name,
bool constant) const;
static qsizetype indexOfFunction(const FunctionDocumentationList &fl,
const FunctionDocumentationQuery &q);
qsizetype indexOfProperty(const QString &name) const;
Type type = Type::Class;
QString name;
QString description;
QList<EnumDocumentation> enums;
QList<PropertyDocumentation> properties;
FunctionDocumentationList functions;
};
/// Parse a WebXML class/namespace document
std::optional<ClassDocumentation> parseWebXml(const QString &fileName, QString *errorMessage);
/// Extract the module description from a WebXML module document
QString webXmlModuleDescription(const QString &fileName, QString *errorMessage);
QDebug operator<<(QDebug debug, const EnumDocumentation &e);
QDebug operator<<(QDebug debug, const PropertyDocumentation &p);
QDebug operator<<(QDebug debug, const FunctionDocumentationQuery &q);
QDebug operator<<(QDebug debug, const FunctionDocumentation &f);
QDebug operator<<(QDebug debug, const ClassDocumentation &c);
#endif // CLASSDOCUMENTATION_H
|
