diff options
| author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2024-09-26 09:36:30 +0200 |
|---|---|---|
| committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2024-09-26 13:18:18 +0200 |
| commit | f368b8a4b389c1145e423bc4f3fb7ed4787a72e6 (patch) | |
| tree | 1e39d4794d866ca17ce897e353ab8aacebd8ed4c /sources/shiboken6/ApiExtractor/doxygenparser.cpp | |
| parent | fb2596a47cd64a06b1c2208158f9eb94acca6083 (diff) | |
shiboken6/Documentation: Return documention source file from the DocParser (doxygen/qdoc)
As a drive-by skip private fields in doxygen instead of quitting.
Task-number: PYSIDE-2620
Task-number: PYSIDE-1106
Change-Id: Ieb488e6168d736aa1b11e2737eb118fdb3f485cd
Reviewed-by: Shyamnath Premnadh <Shyamnath.Premnadh@qt.io>
Diffstat (limited to 'sources/shiboken6/ApiExtractor/doxygenparser.cpp')
| -rw-r--r-- | sources/shiboken6/ApiExtractor/doxygenparser.cpp | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/sources/shiboken6/ApiExtractor/doxygenparser.cpp b/sources/shiboken6/ApiExtractor/doxygenparser.cpp index da790015f..c8cae38a5 100644 --- a/sources/shiboken6/ApiExtractor/doxygenparser.cpp +++ b/sources/shiboken6/ApiExtractor/doxygenparser.cpp @@ -41,10 +41,10 @@ Documentation DoxygenParser::retrieveModuleDocumentation() return retrieveModuleDocumentation(packageName()); } -void DoxygenParser::fillDocumentation(const AbstractMetaClassPtr &metaClass) +QString DoxygenParser::fillDocumentation(const AbstractMetaClassPtr &metaClass) { if (!metaClass) - return; + return {}; QString doxyFileSuffix; if (metaClass->enclosingClass()) { @@ -70,14 +70,14 @@ void DoxygenParser::fillDocumentation(const AbstractMetaClassPtr &metaClass) << "Can't find doxygen file for class " << metaClass->name() << ", tried: " << QDir::toNativeSeparators(documentationDataDirectory()) << "/{struct|class|namespace}"<< doxyFileSuffix; - return; + return {}; } QString errorMessage; XQueryPtr xquery = XQuery::create(doxyFilePath, &errorMessage); if (!xquery) { qCWarning(lcShibokenDoc, "%s", qPrintable(errorMessage)); - return; + return {}; } static const QList<std::pair<Documentation::Type, QString>> docTags = { @@ -166,7 +166,7 @@ void DoxygenParser::fillDocumentation(const AbstractMetaClassPtr &metaClass) //Fields for (AbstractMetaField &field : metaClass->fields()) { if (field.isPrivate()) - return; + continue; Documentation fieldDoc; for (const auto &tag : docTags) { @@ -196,6 +196,7 @@ void DoxygenParser::fillDocumentation(const AbstractMetaClassPtr &metaClass) meta_enum.setDocumentation(Documentation(doc, {})); } + return doxyFilePath; } Documentation DoxygenParser::retrieveModuleDocumentation(const QString& name){ |