diff options
| author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2018-02-20 12:30:47 +0100 |
|---|---|---|
| committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2018-02-21 10:03:20 +0000 |
| commit | b461e45a8e3b6f80f9e6a3b4505867ece6799355 (patch) | |
| tree | 39989795d1d6d8474a444648258cddb3fe839d08 /sources/shiboken2/ApiExtractor/docparser.h | |
| parent | 5e4e428210742d252fe73e46e4c3393375173e0c (diff) | |
DocParser: Add helper function to create list of documentable functions
Move code from shouldSkip() helper of the doc generator
into the doc parser and use that for the qdoc/doxygen parsers.
The additional checks (most importantly the check for
declaringClass != ownerClass excluding the virtual functions
added by AbstractMetaClass::fixFunctions() to derived classes)
avoid running unneeded XPATH queries.
Task-number: PYSIDE-363
Change-Id: Ib1141a348c96b269a50c63dd94fe93931c12d1ec
Reviewed-by: Alexandru Croitor <alexandru.croitor@qt.io>
Diffstat (limited to 'sources/shiboken2/ApiExtractor/docparser.h')
| -rw-r--r-- | sources/shiboken2/ApiExtractor/docparser.h | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/sources/shiboken2/ApiExtractor/docparser.h b/sources/shiboken2/ApiExtractor/docparser.h index 5573f6851..afca254a4 100644 --- a/sources/shiboken2/ApiExtractor/docparser.h +++ b/sources/shiboken2/ApiExtractor/docparser.h @@ -29,6 +29,7 @@ #define DOCPARSER_H #include "typesystem_typedefs.h" +#include "abstractmetalang_typedefs.h" #include <QtCore/QString> @@ -110,10 +111,15 @@ public: */ virtual Documentation retrieveModuleDocumentation(const QString& name) = 0; + static bool skipForQuery(const AbstractMetaFunction *func); + protected: QString getDocumentation(QXmlQuery& xquery, const QString& query, const DocModificationList& mods) const; + + static AbstractMetaFunctionList documentableFunctions(const AbstractMetaClass *metaClass); + private: QString m_packageName; QString m_docDataDir; |