aboutsummaryrefslogtreecommitdiffstats
path: root/docparser.h
diff options
context:
space:
mode:
authorHugo Parente Lima <hugo.pl@gmail.com>2010-09-24 14:28:42 -0300
committerHugo Parente Lima <hugo.pl@gmail.com>2012-03-09 19:10:10 -0300
commit2bfe59a2b8a588b338da7b9472d4ec6f66c2d10a (patch)
treeaf6a5fa06e12204cd3cf1fa1e256d7f4579b4966 /docparser.h
parentf3a9cdbeb96ba5346f11ea5ef618b127684cfc72 (diff)
Add retrieveModuleDocumentation(modName) function to DocParser API.
Reviewer: Luciano Wolf <luciano.wolf@openbossa.org> Marcelo Lira <marcelo.lira@openbossa.org>
Diffstat (limited to 'docparser.h')
-rw-r--r--docparser.h9
1 files changed, 9 insertions, 0 deletions
diff --git a/docparser.h b/docparser.h
index 3c32dc2f..6764333b 100644
--- a/docparser.h
+++ b/docparser.h
@@ -91,6 +91,15 @@ public:
return m_packageName;
}
+ /**
+ * Process and retrieves documentation concerning the entire
+ * module or library.
+ * \param name module name
+ * \return object containing module/library documentation information
+ * \todo Merge with retrieveModuleDocumentation() on next ABI change.
+ */
+ virtual Documentation retrieveModuleDocumentation(const QString& name) = 0;
+
protected:
QString getDocumentation(QXmlQuery& xquery, const QString& query,
const DocModificationList& mods) const;