diff options
| author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2022-11-08 08:16:36 +0100 |
|---|---|---|
| committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2022-11-08 11:37:16 +0100 |
| commit | a824208f187162daa8eb0c79fbca4b5b5826efb5 (patch) | |
| tree | 5da1814bb72db98eb8f275aabbeaa1f5a80a3de2 /sources/shiboken6/ApiExtractor/qtdocparser.cpp | |
| parent | 274cd626332729ab1beca399572c8d30f9edc7c1 (diff) | |
Documentation: Indicate enum types
Insert the base class into the WebXML doc string.
Pick-to: 6.4
Task-number: PYSIDE-1735
Change-Id: I5b59df98f929c82112903bb316143b592c06e33e
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
Diffstat (limited to 'sources/shiboken6/ApiExtractor/qtdocparser.cpp')
| -rw-r--r-- | sources/shiboken6/ApiExtractor/qtdocparser.cpp | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/sources/shiboken6/ApiExtractor/qtdocparser.cpp b/sources/shiboken6/ApiExtractor/qtdocparser.cpp index 3829c3463..236ca4c31 100644 --- a/sources/shiboken6/ApiExtractor/qtdocparser.cpp +++ b/sources/shiboken6/ApiExtractor/qtdocparser.cpp @@ -292,7 +292,17 @@ void QtDocParser::fillDocumentation(AbstractMetaClass* metaClass) Documentation enumDoc; const auto index = classDocumentation.indexOfEnum(meta_enum.name()); if (index != -1) { - enumDoc.setValue(classDocumentation.enums.at(index).description); + QString doc = classDocumentation.enums.at(index).description; + const auto firstPara = doc.indexOf(u"<para>"); + if (firstPara != -1) { + const QString baseClass = QtDocParser::enumBaseClass(meta_enum); + if (baseClass != u"Enum") { + const QString note = u"(inherits <teletype>enum."_s + baseClass + + u"</teletype>) "_s; + doc.insert(firstPara + 6, note); + } + } + enumDoc.setValue(doc); meta_enum.setDocumentation(enumDoc); } else { qCWarning(lcShibokenDoc, "%s", |