aboutsummaryrefslogtreecommitdiffstats
path: root/sources/shiboken6/ApiExtractor/classdocumentation.h
diff options
context:
space:
mode:
Diffstat (limited to 'sources/shiboken6/ApiExtractor/classdocumentation.h')
-rw-r--r--sources/shiboken6/ApiExtractor/classdocumentation.h83
1 files changed, 0 insertions, 83 deletions
diff --git a/sources/shiboken6/ApiExtractor/classdocumentation.h b/sources/shiboken6/ApiExtractor/classdocumentation.h
deleted file mode 100644
index 7ed5c02f5..000000000
--- a/sources/shiboken6/ApiExtractor/classdocumentation.h
+++ /dev/null
@@ -1,83 +0,0 @@
-// 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.h>
-
-#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
-{
- QStringList parameterNames;
- QString signature;
- QString returnType;
- QString description;
-};
-
-using FunctionDocumentationList = QList<FunctionDocumentation>;
-
-/// A WebXML/doxygen document
-struct ClassDocumentation
-{
- enum Type : std::uint8_t {
- 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 QStringList &fileNames, 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