diff options
| author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2022-10-21 15:07:58 +0200 |
|---|---|---|
| committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2022-11-03 09:58:08 +0200 |
| commit | 1ab21cc38197104ccaef0fd3049873e175b69b3c (patch) | |
| tree | 24cb3acb064102f452680896d805a866fd3bf852 | |
| parent | 3597752f58a237dfb8fec897822bb78e46905955 (diff) | |
shiboken6/Documentation: Use the py:method directives
They allow for additional annotations like abstract or final.
Pick-to: 6.4
Task-number: PYSIDE-1106
Change-Id: Ib72cc301f7e0ea58154ddd591228c7230f8749bd
Reviewed-by: Adrian Herrmann <adrian.herrmann@qt.io>
Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
| -rw-r--r-- | sources/shiboken6/generator/qtdoc/qtdocgenerator.cpp | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/sources/shiboken6/generator/qtdoc/qtdocgenerator.cpp b/sources/shiboken6/generator/qtdoc/qtdocgenerator.cpp index c0b2c37b8..a378a9e6f 100644 --- a/sources/shiboken6/generator/qtdoc/qtdocgenerator.cpp +++ b/sources/shiboken6/generator/qtdoc/qtdocgenerator.cpp @@ -247,9 +247,9 @@ void QtDocGenerator::generateClass(TextStream &s, const GeneratorContext &classC continue; if (func->isStatic()) - s << ".. staticmethod:: "; + s << ".. py:staticmethod:: "; else - s << ".. method:: "; + s << ".. py:method:: "; writeFunction(s, metaClass, func, !uniqueFunctions.contains(func->name())); uniqueFunctions.append(func->name()); @@ -685,6 +685,10 @@ void QtDocGenerator::writeFunction(TextStream& s, const AbstractMetaClass* cppCl Indentation indentation(s); if (!indexed) s << "\n:noindex:"; + if (func->attributes().testFlag(AbstractMetaFunction::Attribute::FinalCppMethod)) + s << "\n:final:"; + else if (func->isAbstract()) + s << "\n:abstractmethod:"; s << "\n\n"; writeFunctionParametersType(s, cppClass, func); const auto version = versionOf(func->typeEntry()); |