Orb/Doxygen/src/xmlditaparammap.h
changeset 4 468f4c8d3d5b
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Orb/Doxygen/src/xmlditaparammap.h	Wed Aug 11 14:49:30 2010 +0100
@@ -0,0 +1,36 @@
+/******************************************************************************
+ *
+ * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
+ *
+ * Permission to use, copy, modify, and distribute this software and its
+ * documentation under the terms of the GNU General Public License is hereby 
+ * granted. No representations are made about the suitability of this software 
+ * for any purpose. It is provided "as is" without express or implied warranty.
+ * See the GNU General Public License for more details.
+ *
+ */
+
+#ifndef XMLPARAMMAP_H
+#define XMLPARAMMAP_H
+#include "xmldita.h"
+#include <qmap.h>
+#include <qstring.h>
+
+/** Used for extracting parameter descriptions */
+typedef QMap<QString, QString> ParamDescriptionMap;
+
+/** A structure that is used to extract documetation for paramaters, template parameters
+and return value froma documentation (comment) block. This is used by the DITA doc visitor
+the DITA generator.
+*/
+typedef struct DocBlockContents {
+	ParamDescriptionMap paramMap;
+	ParamDescriptionMap tparamMap;
+	QString returnDoc;
+} DocBlockContentsType;
+
+void DumpDocBlockContents(const DocBlockContentsType& theBlock);
+
+#endif // XMLPARAMMAP_H
+
+