1 /******************************************************************************

     2  *

     3  * Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).

     4  *

     5  * Permission to use, copy, modify, and distribute this software and its

     6  * documentation under the terms of the GNU General Public License is hereby 

     7  * granted. No representations are made about the suitability of this software 

     8  * for any purpose. It is provided "as is" without express or implied warranty.

     9  * See the GNU General Public License for more details.

    10  *

    11  */

    12 

    13 #ifndef XMLPARAMMAP_H

    14 #define XMLPARAMMAP_H

    15 #include "xmldita.h"

    16 #include <qmap.h>

    17 #include <qstring.h>

    18 

    19 /** Used for extracting parameter descriptions */

    20 typedef QMap<QString, QString> ParamDescriptionMap;

    21 

    22 /** A structure that is used to extract documetation for paramaters, template parameters

    23 and return value froma documentation (comment) block. This is used by the DITA doc visitor

    24 the DITA generator.

    25 */

    26 typedef struct DocBlockContents {

    27 	ParamDescriptionMap paramMap;

    28 	ParamDescriptionMap tparamMap;

    29 	QString returnDoc;

    30 } DocBlockContentsType;

    31 

    32 void DumpDocBlockContents(const DocBlockContentsType& theBlock);

    33 

    34 #endif // XMLPARAMMAP_H

    35 

    36