aboutsummaryrefslogtreecommitdiffstats
path: root/sources/shiboken2/ApiExtractor/docparser.h
diff options
context:
space:
mode:
Diffstat (limited to 'sources/shiboken2/ApiExtractor/docparser.h')
-rw-r--r--sources/shiboken2/ApiExtractor/docparser.h22
1 files changed, 22 insertions, 0 deletions
diff --git a/sources/shiboken2/ApiExtractor/docparser.h b/sources/shiboken2/ApiExtractor/docparser.h
index 5573f6851..1770815b0 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,31 @@ 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);
+
+ static QString msgCannotFindDocumentation(const QString &fileName,
+ const char *what, const QString &name,
+ const QString &query);
+ static QString msgCannotFindDocumentation(const QString &fileName,
+ const AbstractMetaClass *metaClass,
+ const AbstractMetaFunction *function,
+ const QString &query);
+ static QString msgCannotFindDocumentation(const QString &fileName,
+ const AbstractMetaClass *metaClass,
+ const AbstractMetaEnum *e,
+ const QString &query);
+ static QString msgCannotFindDocumentation(const QString &fileName,
+ const AbstractMetaClass *metaClass,
+ const AbstractMetaField *f,
+ const QString &query);
+
private:
QString m_packageName;
QString m_docDataDir;