aboutsummaryrefslogtreecommitdiffstats
path: root/sources/shiboken6/generator/qtdoc/qtxmltosphinxinterface.h
diff options
context:
space:
mode:
Diffstat (limited to 'sources/shiboken6/generator/qtdoc/qtxmltosphinxinterface.h')
-rw-r--r--sources/shiboken6/generator/qtdoc/qtxmltosphinxinterface.h22
1 files changed, 22 insertions, 0 deletions
diff --git a/sources/shiboken6/generator/qtdoc/qtxmltosphinxinterface.h b/sources/shiboken6/generator/qtdoc/qtxmltosphinxinterface.h
index c4bdedd21..d4e792d76 100644
--- a/sources/shiboken6/generator/qtdoc/qtxmltosphinxinterface.h
+++ b/sources/shiboken6/generator/qtdoc/qtxmltosphinxinterface.h
@@ -43,6 +43,26 @@ struct QtXmlToSphinxParameters
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:
@@ -54,6 +74,8 @@ public:
virtual const QLoggingCategory &loggingCategory() const = 0;
+ virtual QtXmlToSphinxLink resolveLink(const QtXmlToSphinxLink &) const = 0;
+
virtual ~QtXmlToSphinxDocGeneratorInterface() = default;
};