Add retrieveModuleDocumentation(modName) function to DocParser API.

Reviewer: Luciano Wolf <luciano.wolf@openbossa.org>
          Marcelo Lira <marcelo.lira@openbossa.org>

1 files changed, 9 insertions, 0 deletions

diff --git a/docparser.h b/docparser.h
index 3c32dc2f0..6764333be 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;