diff options
| author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2022-11-22 13:30:16 +0100 |
|---|---|---|
| committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2022-11-25 09:14:11 +0100 |
| commit | c6000ddef0d50c3c6068c92b8066a1b73be9ad45 (patch) | |
| tree | 3a40e83f007bb130258e900efaa06617a7512edf /sources/shiboken6/ApiExtractor/qtdocparser.cpp | |
| parent | 59f159de51345d122638e16ad395cb00433c0d04 (diff) | |
shiboken6: Generate property documentation
Previously, the documentation generator used to insert
the property documentation at the getter/setter function documentation.
The properties for use with true_property are hard to discover in this
scheme.
To fix this, add a separate TOC section and description list
for the properties using the sphinx :py:property: directive
and link to it from the functions and signals instead.
This mimicks the C++ documentation.
Task-number: PYSIDE-1106
Task-number: PYSIDE-1019
Pick-to: 6.4
Change-Id: I976fee91a02ca4c8a7c62c7d957ecaea59ac4ebc
Reviewed-by: Christian Tismer <tismer@stackless.com>
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 | 11 |
1 files changed, 0 insertions, 11 deletions
diff --git a/sources/shiboken6/ApiExtractor/qtdocparser.cpp b/sources/shiboken6/ApiExtractor/qtdocparser.cpp index 6d8a0eba6..8daf1ad85 100644 --- a/sources/shiboken6/ApiExtractor/qtdocparser.cpp +++ b/sources/shiboken6/ApiExtractor/qtdocparser.cpp @@ -123,17 +123,6 @@ QString QtDocParser::queryFunctionDocumentation(const QString &sourceFileName, const AbstractMetaFunctionCPtr &func, QString *errorMessage) { - // Properties - if (func->isPropertyReader() || func->isPropertyWriter() || func->isPropertyResetter()) { - const QPropertySpec &prop = metaClass->propertySpecs().at(func->propertySpecIndex()); - const auto index = classDocumentation.indexOfProperty(prop.name()); - if (index == -1) { - *errorMessage = msgCannotFindDocumentation(sourceFileName, func.data()); - return {}; - } - return classDocumentation.properties.at(index).description; - } - // Search candidates by name and const-ness FunctionDocumentationList candidates = classDocumentation.findFunctionCandidates(func->name(), func->isConstant()); |