aboutsummaryrefslogtreecommitdiffstats
path: root/sources/shiboken2/ApiExtractor/doxygenparser.cpp
diff options
context:
space:
mode:
authorFriedemann Kleint <Friedemann.Kleint@qt.io>2018-02-26 18:00:56 +0100
committerFriedemann Kleint <Friedemann.Kleint@qt.io>2018-02-26 18:00:59 +0100
commita7145c2e80ed0d176f3a567cc061b4cac5e4a75a (patch)
tree7edb0b98b04365a9197aaf01ce26460031c37796 /sources/shiboken2/ApiExtractor/doxygenparser.cpp
parent18ae2b64af6a1f48ff014c22f3b0bc7026b7ce43 (diff)
parent88d29b1f08955f11eaebcb0ecc8faba7a5c50965 (diff)
Merge remote-tracking branch 'origin/5.9' into dev
Diffstat (limited to 'sources/shiboken2/ApiExtractor/doxygenparser.cpp')
-rw-r--r--sources/shiboken2/ApiExtractor/doxygenparser.cpp26
1 files changed, 17 insertions, 9 deletions
diff --git a/sources/shiboken2/ApiExtractor/doxygenparser.cpp b/sources/shiboken2/ApiExtractor/doxygenparser.cpp
index 6b90fe6fc..1cffa3b67 100644
--- a/sources/shiboken2/ApiExtractor/doxygenparser.cpp
+++ b/sources/shiboken2/ApiExtractor/doxygenparser.cpp
@@ -96,20 +96,16 @@ void DoxygenParser::fillDocumentation(AbstractMetaClass* metaClass)
xquery.setFocus(QUrl(doxyFilePath));
// Get class documentation
- QString classDoc = getDocumentation(xquery, QLatin1String("/doxygen/compounddef/detaileddescription"),
+ const QString classQuery = QLatin1String("/doxygen/compounddef/detaileddescription");
+ QString classDoc = getDocumentation(xquery, classQuery,
metaClass->typeEntry()->docModifications());
- if (classDoc.isEmpty()) {
- qCWarning(lcShiboken).noquote().nospace()
- << "Can't find documentation for class \"" << metaClass->name() << "\".";
- }
+ if (classDoc.isEmpty())
+ qCWarning(lcShiboken(), "%s", qPrintable(msgCannotFindDocumentation(doxyFilePath, "class", metaClass->name(), classQuery)));
metaClass->setDocumentation(classDoc);
//Functions Documentation
- const AbstractMetaFunctionList &funcs = metaClass->functionsInTargetLang();
+ const AbstractMetaFunctionList &funcs = DocParser::documentableFunctions(metaClass);
for (AbstractMetaFunction *func : funcs) {
- if (!func || func->isPrivate())
- continue;
-
QString query = QLatin1String("/doxygen/compounddef/sectiondef");
// properties
if (func->isPropertyReader() || func->isPropertyWriter()
@@ -150,6 +146,10 @@ void DoxygenParser::fillDocumentation(AbstractMetaClass* metaClass)
query += QLatin1String("/../detaileddescription)[1]");
}
QString doc = getDocumentation(xquery, query, DocModificationList());
+ if (doc.isEmpty()) {
+ qCWarning(lcShiboken(), "%s",
+ qPrintable(msgCannotFindDocumentation(doxyFilePath, metaClass, func, query)));
+ }
func->setDocumentation(doc);
isProperty = false;
}
@@ -163,6 +163,10 @@ void DoxygenParser::fillDocumentation(AbstractMetaClass* metaClass)
QString query = QLatin1String("/doxygen/compounddef/sectiondef/memberdef/name[text()=\"")
+ field->name() + QLatin1String("\"]/../detaileddescription");
QString doc = getDocumentation(xquery, query, DocModificationList());
+ if (doc.isEmpty()) {
+ qCWarning(lcShiboken(), "%s",
+ qPrintable(msgCannotFindDocumentation(doxyFilePath, metaClass, field, query)));
+ }
field->setDocumentation(doc);
}
@@ -172,6 +176,10 @@ void DoxygenParser::fillDocumentation(AbstractMetaClass* metaClass)
QString query = QLatin1String("/doxygen/compounddef/sectiondef/memberdef[@kind=\"enum\"]/name[text()=\"")
+ meta_enum->name() + QLatin1String("\"]/..");
QString doc = getDocumentation(xquery, query, DocModificationList());
+ if (doc.isEmpty()) {
+ qCWarning(lcShiboken(), "%s",
+ qPrintable(msgCannotFindDocumentation(doxyFilePath, metaClass, meta_enum, query)));
+ }
meta_enum->setDocumentation(doc);
}