Release-1.2.9.1

15 files changed, 340 insertions, 3 deletions

diff --git a/addon/doxywizard/doxywizard.cpp b/addon/doxywizard/doxywizard.cpp
index 3fcde0b..1a31b1a 100644
--- a/addon/doxywizard/doxywizard.cpp
+++ b/addon/doxywizard/doxywizard.cpp
@@ -62,7 +62,7 @@ static bool loadConfig( QString loadFile )
 
   // parse the config file
   // this will initialize the various Config data members
-  if (Config::instance()->parse(loadFile))
+  if (!Config::instance()->parse(loadFile))
   {
     QMessageBox::warning(0,
                          "Warning","Cannot open or read input "+loadFile+"!",
@@ -89,7 +89,7 @@ static bool saveConfig( QString saveFile )
     return FALSE; // failure
   }
 
-  Config::instance()->writeTemplate(&f,TRUE,TRUE); // write brief config file
+  Config::instance()->writeTemplate(&f,TRUE,FALSE); // write brief config file
 
   return TRUE; // success
 }
diff --git a/addon/xmlparse/basehandler.h b/addon/xmlparse/basehandler.h
index 2d037e0..0bf7c68 100644
--- a/addon/xmlparse/basehandler.h
+++ b/addon/xmlparse/basehandler.h
@@ -1,3 +1,18 @@
+/******************************************************************************
+ *
+ * $Id$
+ *
+ *
+ * Copyright (C) 1997-2001 by Dimitri van Heesch.
+ *
+ * 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 _BASEHANDLER_H
 #define _BASEHANDLER_H
 
diff --git a/addon/xmlparse/compoundhandler.cpp b/addon/xmlparse/compoundhandler.cpp
index 4949f63..c299397 100644
--- a/addon/xmlparse/compoundhandler.cpp
+++ b/addon/xmlparse/compoundhandler.cpp
@@ -1,3 +1,18 @@
+/******************************************************************************
+ *
+ * $Id$
+ *
+ *
+ * Copyright (C) 1997-2001 by Dimitri van Heesch.
+ *
+ * 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.
+ *
+ */
+
 #include "mainhandler.h"
 #include "compoundhandler.h"
 #include "dochandler.h"
diff --git a/addon/xmlparse/compoundhandler.h b/addon/xmlparse/compoundhandler.h
index cd7da55..29556a0 100644
--- a/addon/xmlparse/compoundhandler.h
+++ b/addon/xmlparse/compoundhandler.h
@@ -1,3 +1,17 @@
+/******************************************************************************
+ *
+ * $Id$
+ *
+ *
+ * Copyright (C) 1997-2001 by Dimitri van Heesch.
+ *
+ * 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 _COMPOUNDHANDLER_H
 #define _COMPOUNDHANDLER_H
 
diff --git a/addon/xmlparse/dochandler.cpp b/addon/xmlparse/dochandler.cpp
index c9a96c4..4e91d8f 100644
--- a/addon/xmlparse/dochandler.cpp
+++ b/addon/xmlparse/dochandler.cpp
@@ -1,3 +1,18 @@
+/******************************************************************************
+ *
+ * $Id$
+ *
+ *
+ * Copyright (C) 1997-2001 by Dimitri van Heesch.
+ *
+ * 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.
+ *
+ */
+
 #include "dochandler.h"
 
 //----------------------------------------------------------------------
@@ -218,6 +233,37 @@ void ListHandler::startListItem(const QXmlAttributes& attrib)
 }
 
 //----------------------------------------------------------------------
+// ParameterHandler
+//----------------------------------------------------------------------
+
+
+//----------------------------------------------------------------------
+// ParameterListHandler
+//----------------------------------------------------------------------
+
+ParameterListHandler::ParameterListHandler(IBaseHandler *parent) 
+  : DocNode(ParameterList), m_parent(parent)
+{
+  addEndHandler("parameterlist",this,&ParameterListHandler::endParameterList);
+  m_parameters.setAutoDelete(TRUE);
+  m_curParam=0;
+}
+
+ParameterListHandler::~ParameterListHandler()
+{
+}
+
+void ParameterListHandler::startParameterList(const QXmlAttributes& /*attrib*/)
+{
+  m_parent->setDelegate(this);
+}
+
+void ParameterListHandler::endParameterList()
+{
+  m_parent->setDelegate(0);
+}
+
+//----------------------------------------------------------------------
 // ParagraphHandler
 //----------------------------------------------------------------------
 
@@ -268,6 +314,14 @@ void ParagraphHandler::startOrderedList(const QXmlAttributes& attrib)
   m_children.append(listHandler);
 }
 
+void ParagraphHandler::startParameterList(const QXmlAttributes& attrib)
+{
+  addTextNode();
+  ParameterListHandler *parListHandler = new ParameterListHandler(this);
+  parListHandler->startParameterList(attrib);
+  m_children.append(parListHandler);
+}
+
 void ParagraphHandler::addTextNode()
 {
   if (!m_curString.isEmpty())
diff --git a/addon/xmlparse/dochandler.h b/addon/xmlparse/dochandler.h
index 761842f..376d6f8 100644
--- a/addon/xmlparse/dochandler.h
+++ b/addon/xmlparse/dochandler.h
@@ -1,3 +1,18 @@
+/******************************************************************************
+ *
+ * $Id$
+ *
+ *
+ * Copyright (C) 1997-2001 by Dimitri van Heesch.
+ *
+ * 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 _DOCHANDLER_H
 #define _DOCHANDLER_H
 
@@ -7,6 +22,13 @@
 
 #include "basehandler.h"
 
+class ParagraphHandler;
+
+//-----------------------------------------------------------------------------
+
+/*! \brief Node of a structured documentation tree.
+ *
+ */
 class DocNode
 {
   public:
@@ -28,7 +50,8 @@ class DocNode
       MarkupModifier,
       ItemizedList,
       OrderedList,
-      ListItem
+      ListItem,
+      ParameterList
     };
     DocNode(NodeKind k) : m_kind(k) {}
     virtual ~DocNode() {}
@@ -37,6 +60,12 @@ class DocNode
     NodeKind m_kind;
 };
 
+//-----------------------------------------------------------------------------
+
+
+/*! \brief Node representing a piece of text.
+ *
+ */
 class TextNode : public DocNode
 {
   public:
@@ -48,6 +77,11 @@ class TextNode : public DocNode
     int m_markup;
 };
 
+//-----------------------------------------------------------------------------
+
+/*! \brief Node representing a change in the markup style.
+ *
+ */
 class MarkupModifierNode : public DocNode
 {
   public:
@@ -59,6 +93,12 @@ class MarkupModifierNode : public DocNode
     bool m_enabled;
 };
 
+
+//-----------------------------------------------------------------------------
+
+/*! \brief Handles markup commands in the XML input. 
+ *
+ */
 class MarkupHandler : public BaseFallBackHandler<MarkupHandler>
 {
   public:
@@ -90,6 +130,12 @@ class MarkupHandler : public BaseFallBackHandler<MarkupHandler>
     int             m_curMarkup;
 };
 
+
+//-----------------------------------------------------------------------------
+
+/*! \brief Node representing a list item.
+ *
+ */
 class ListItemHandler : public DocNode, public BaseHandler<ListItemHandler>
 {
   public:
@@ -104,6 +150,12 @@ class ListItemHandler : public DocNode, public BaseHandler<ListItemHandler>
     QList<DocNode>  m_children;
 };
 
+
+//-----------------------------------------------------------------------------
+
+/*! \brief Node representing list of items.
+ *
+ */
 class ListHandler : public DocNode, public BaseHandler<ListHandler>
 {
   public:
@@ -118,6 +170,53 @@ class ListHandler : public DocNode, public BaseHandler<ListHandler>
     QList<DocNode>  m_children;
 };
 
+
+//-----------------------------------------------------------------------------
+
+/*! \brief Node representing a parameter.
+ *
+ */
+class ParameterHandler : public DocNode, 
+                         public BaseHandler<ParameterHandler>
+{
+  public:
+    ParameterHandler(IBaseHandler *parent);
+    virtual ~ParameterHandler();
+    virtual void startParameterList(const QXmlAttributes& attrib);
+    virtual void endParameterList();
+
+  private:
+    IBaseHandler     *m_parent;
+    QString           m_name;
+    ParagraphHandler *m_description;
+};
+
+
+//-----------------------------------------------------------------------------
+
+/* \brief Node representing a parameter list.
+ *
+ */
+class ParameterListHandler : public DocNode, 
+                             public BaseHandler<ParameterListHandler>
+{
+  public:
+    ParameterListHandler(IBaseHandler *parent);
+    virtual ~ParameterListHandler();
+    virtual void startParameterList(const QXmlAttributes& attrib);
+    virtual void endParameterList();
+
+  private:
+    IBaseHandler            *m_parent;
+    QList<ParameterHandler>  m_parameters;
+    ParameterHandler        *m_curParam;
+};
+
+//-----------------------------------------------------------------------------
+
+/*! \brief Node representing a paragraph of text and commands.
+ *
+ */
 class ParagraphHandler : public DocNode, public BaseHandler<ParagraphHandler>
 {
   public:
@@ -125,6 +224,7 @@ class ParagraphHandler : public DocNode, public BaseHandler<ParagraphHandler>
     virtual void endParagraph();
     virtual void startItemizedList(const QXmlAttributes& attrib);
     virtual void startOrderedList(const QXmlAttributes& attrib);
+    virtual void startParameterList(const QXmlAttributes& attrib);
 
     ParagraphHandler(IBaseHandler *parent);
     virtual ~ParagraphHandler();
@@ -136,7 +236,11 @@ class ParagraphHandler : public DocNode, public BaseHandler<ParagraphHandler>
     MarkupHandler  *m_markupHandler;
 };
 
+//-----------------------------------------------------------------------------
 
+/*! \brief Node representing a documentation block.
+ *
+ */
 class DocHandler : public BaseHandler<DocHandler>
 {
   public:
diff --git a/addon/xmlparse/main.cpp b/addon/xmlparse/main.cpp
index 82cc849..60f4142 100644
--- a/addon/xmlparse/main.cpp
+++ b/addon/xmlparse/main.cpp
@@ -1,3 +1,18 @@
+/******************************************************************************
+ *
+ * $Id$
+ *
+ *
+ * Copyright (C) 1997-2001 by Dimitri van Heesch.
+ *
+ * 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.
+ *
+ */
+
 #include "mainhandler.h"
 
 #include <qstring.h>
diff --git a/addon/xmlparse/mainhandler.cpp b/addon/xmlparse/mainhandler.cpp
index b062578..8a5d449 100644
--- a/addon/xmlparse/mainhandler.cpp
+++ b/addon/xmlparse/mainhandler.cpp
@@ -1,3 +1,18 @@
+/******************************************************************************
+ *
+ * $Id$
+ *
+ *
+ * Copyright (C) 1997-2001 by Dimitri van Heesch.
+ *
+ * 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.
+ *
+ */
+
 #include "mainhandler.h"
 
 void MainHandler::startCompound(const QXmlAttributes& attrib)
diff --git a/addon/xmlparse/mainhandler.h b/addon/xmlparse/mainhandler.h
index 20eedc3..75a3b98 100644
--- a/addon/xmlparse/mainhandler.h
+++ b/addon/xmlparse/mainhandler.h
@@ -1,3 +1,18 @@
+/******************************************************************************
+ *
+ * $Id$
+ *
+ *
+ * Copyright (C) 1997-2001 by Dimitri van Heesch.
+ *
+ * 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 _MAINHANDLER_H
 #define _MAINHANDLER_H
 
diff --git a/addon/xmlparse/memberhandler.cpp b/addon/xmlparse/memberhandler.cpp
index 1130f8d..4cbe4a6 100644
--- a/addon/xmlparse/memberhandler.cpp
+++ b/addon/xmlparse/memberhandler.cpp
@@ -1,3 +1,18 @@
+/******************************************************************************
+ *
+ * $Id$
+ *
+ *
+ * Copyright (C) 1997-2001 by Dimitri van Heesch.
+ *
+ * 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.
+ *
+ */
+
 #include "memberhandler.h"
 #include "sectionhandler.h"
 #include "dochandler.h"
diff --git a/addon/xmlparse/memberhandler.h b/addon/xmlparse/memberhandler.h
index 5f19ee2..e18e59c 100644
--- a/addon/xmlparse/memberhandler.h
+++ b/addon/xmlparse/memberhandler.h
@@ -1,3 +1,18 @@
+/******************************************************************************
+ *
+ * $Id$
+ *
+ *
+ * Copyright (C) 1997-2001 by Dimitri van Heesch.
+ *
+ * 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 _MEMBERHANDLER_H
 #define _MEMBERHANDLER_H
 
diff --git a/addon/xmlparse/paramhandler.cpp b/addon/xmlparse/paramhandler.cpp
index 3563ebd..a800195 100644
--- a/addon/xmlparse/paramhandler.cpp
+++ b/addon/xmlparse/paramhandler.cpp
@@ -1,3 +1,18 @@
+/******************************************************************************
+ *
+ * $Id$
+ *
+ *
+ * Copyright (C) 1997-2001 by Dimitri van Heesch.
+ *
+ * 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.
+ *
+ */
+
 #include "paramhandler.h"
 #include "memberhandler.h"
 
diff --git a/addon/xmlparse/paramhandler.h b/addon/xmlparse/paramhandler.h
index 062bab1..f93f83f 100644
--- a/addon/xmlparse/paramhandler.h
+++ b/addon/xmlparse/paramhandler.h
@@ -1,3 +1,18 @@
+/******************************************************************************
+ *
+ * $Id$
+ *
+ *
+ * Copyright (C) 1997-2001 by Dimitri van Heesch.
+ *
+ * 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 _PARAMHANDLER_H
 #define _PARAMHANDLER_H
 
diff --git a/addon/xmlparse/sectionhandler.cpp b/addon/xmlparse/sectionhandler.cpp
index 0b63832..80db178 100644
--- a/addon/xmlparse/sectionhandler.cpp
+++ b/addon/xmlparse/sectionhandler.cpp
@@ -1,3 +1,18 @@
+/******************************************************************************
+ *
+ * $Id$
+ *
+ *
+ * Copyright (C) 1997-2001 by Dimitri van Heesch.
+ *
+ * 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.
+ *
+ */
+
 #include "compoundhandler.h"
 #include "sectionhandler.h"
 
diff --git a/addon/xmlparse/sectionhandler.h b/addon/xmlparse/sectionhandler.h
index b2d1ce1..5a4ab2a 100644
--- a/addon/xmlparse/sectionhandler.h
+++ b/addon/xmlparse/sectionhandler.h
@@ -1,3 +1,18 @@
+/******************************************************************************
+ *
+ * $Id$
+ *
+ *
+ * Copyright (C) 1997-2001 by Dimitri van Heesch.
+ *
+ * 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 _SECTIONHANDLER_H
 #define _SECTIONHANDLER_H