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 <[email protected]>

Author: FriedemannKleint

sources/shiboken6/ApiExtractor/docparser.h

@@ -27,7 +27,7 @@ class DocParser
 
     DocParser();
     virtual ~DocParser();
-    virtual void fillDocumentation(const AbstractMetaClassPtr &metaClass) = 0;
+    virtual QString fillDocumentation(const AbstractMetaClassPtr &metaClass) = 0;
     virtual void fillGlobalFunctionDocumentation(const AbstractMetaFunctionPtr &f);
     virtual void fillGlobalEnumDocumentation(AbstractMetaEnum &e);
 

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){

sources/shiboken6/ApiExtractor/doxygenparser.h

@@ -10,7 +10,7 @@ class DoxygenParser : public DocParser
 {
 public:
     DoxygenParser() = default;
-    void fillDocumentation(const AbstractMetaClassPtr &metaClass) override;
+    QString fillDocumentation(const AbstractMetaClassPtr &metaClass) override;
     Documentation retrieveModuleDocumentation() override;
     Documentation retrieveModuleDocumentation(const QString& name) override;
 };

sources/shiboken6/ApiExtractor/qtdocparser.cpp

@@ -299,10 +299,10 @@ void QtDocParser::fillGlobalEnumDocumentation(AbstractMetaEnum &e)
     }
 }
 
-void QtDocParser::fillDocumentation(const AbstractMetaClassPtr &metaClass)
+QString QtDocParser::fillDocumentation(const AbstractMetaClassPtr &metaClass)
 {
     if (!metaClass)
-        return;
+        return {};
 
     auto context = metaClass->enclosingClass();
     while (context) {
@@ -320,7 +320,7 @@ void QtDocParser::fillDocumentation(const AbstractMetaClassPtr &metaClass)
         qCWarning(lcShibokenDoc).noquote().nospace()
             << "Can't find qdoc file for class " << metaClass->name() << ", tried: "
             << QDir::toNativeSeparators(sourceFile.absoluteFilePath());
-        return;
+       return {};
     }
 
     const QString sourceFileName = sourceFile.absoluteFilePath();
@@ -329,7 +329,7 @@ void QtDocParser::fillDocumentation(const AbstractMetaClassPtr &metaClass)
     const auto classDocumentationO = parseWebXml(sourceFileName, &errorMessage);
     if (!classDocumentationO.has_value()) {
         qCWarning(lcShibokenDoc, "%s", qPrintable(errorMessage));
-        return;
+        return {};
     }
 
     const auto &classDocumentation = classDocumentationO.value();
@@ -384,6 +384,8 @@ void QtDocParser::fillDocumentation(const AbstractMetaClassPtr &metaClass)
                       qPrintable(msgCannotFindDocumentation(sourceFileName, metaClass, meta_enum, {})));
         }
     }
+
+    return sourceFileName;
 }
 
 bool QtDocParser::extractEnumDocumentation(const ClassDocumentation &classDocumentation,

sources/shiboken6/ApiExtractor/qtdocparser.h

@@ -12,7 +12,7 @@ class QtDocParser : public DocParser
 {
 public:
     QtDocParser() = default;
-    void fillDocumentation(const AbstractMetaClassPtr &metaClass) override;
+    QString fillDocumentation(const AbstractMetaClassPtr &metaClass) override;
     void fillGlobalFunctionDocumentation(const AbstractMetaFunctionPtr &f) override;
     void fillGlobalEnumDocumentation(AbstractMetaEnum &e) override;