Describe config module in doxygen

diff --git a/doc/Modules.doc b/doc/Modules.doc
index 0b41bfe0b5e4f050ea8205e42ab079fe23803a6c..e891e1cc05e69f2015efe505c74189b166748057 100644 (file)
--- a/doc/Modules.doc
+++ b/doc/Modules.doc
@@ -20,6 +20,7 @@
  * The geometrical algorithms implementation (basing on OCCT libraries) are located in <b>GeomAlgoAPI</b>.
  *
  */
+ 
 
 /**
  * \defgroup Plugins Plugins
@@ -33,6 +34,15 @@
  * <b>PartSetPlugin</b>, <b>ConstructionPlugin</b>, <b>SketchPlugin</b>, <b>FeaturesPlugins</b>, etc.
  *
  */
+ 
+ /**
+ * \defgroup Config Config 
+ *
+ * \brief XML processing tools used in the application
+ * 
+ * The tools for reading definitions of plugins, features and widgets.  
+ *
+ */
 
 /**
  * \defgroup GUI GUI of the application

diff --git a/src/Config/Config_FeatureMessage.h b/src/Config/Config_FeatureMessage.h
index a56d7253ad9e03aa6e551896830af600ed87693d..bfc63dd052c0f0123d62b0f1e5bdd6f2ec362c91 100644 (file)
--- a/src/Config/Config_FeatureMessage.h
+++ b/src/Config/Config_FeatureMessage.h
@@ -10,6 +10,7 @@
 \r
 /*!\r
  * \class Config_FeatureMessage\r
+ * \ingroup Config\r
  * \brief Class to pass a feature entry extracted from xml file.\r
  * Example of the feature entry:\r
  * \code\r

diff --git a/src/Config/Config_FeatureReader.h b/src/Config/Config_FeatureReader.h
index 7c0096ccdf38d687ed74e106421e1b1fc573fcf8..7f7889aaabfbd07fe0ab741f22162b226c354765 100644 (file)
--- a/src/Config/Config_FeatureReader.h
+++ b/src/Config/Config_FeatureReader.h
@@ -22,6 +22,7 @@ class Config_FeatureMessage;
 
 /*!
  * \class Config_FeatureReader
+ * \ingroup Config
  * \brief Class to process feature's xml definition.
  */
 class Config_FeatureReader : public Config_XMLReader

diff --git a/src/Config/Config_ModuleReader.h b/src/Config/Config_ModuleReader.h
index 655a6ca7a91649143313eb953843cc163b8ae1fa..f10762597e565c7113f3952839bcee978b9a9741 100644 (file)
--- a/src/Config/Config_ModuleReader.h
+++ b/src/Config/Config_ModuleReader.h
@@ -20,6 +20,7 @@
 
 /*!
  * \class Config_ModuleReader
+ * \ingroup Config
  * \brief Class to process plugins.xml - definition of plugins (scripts, libraries).
  */
 class Config_ModuleReader : public Config_XMLReader

diff --git a/src/Config/Config_PointerMessage.h b/src/Config/Config_PointerMessage.h
index aafa6b036eb2a1e995d60b51294348bcaba4889d..872c4365509effdc6d0ae624337860874c6f77e4 100644 (file)
--- a/src/Config/Config_PointerMessage.h
+++ b/src/Config/Config_PointerMessage.h
@@ -15,6 +15,7 @@
 
 /*!
  * \class Config_PointerMessage
+ * \ingroup Config
  * \brief A general class to pass pointers over the event loop.
  */
 class CONFIG_EXPORT Config_PointerMessage : public Events_Message

diff --git a/src/Config/Config_Prop.h b/src/Config/Config_Prop.h
index 1cf0c0c53b19e5b0e9ce9462a7c3363d3d06345b..fe64ca05886118dee592df0db576d5a69615a4e5 100644 (file)
--- a/src/Config/Config_Prop.h
+++ b/src/Config/Config_Prop.h
@@ -12,7 +12,11 @@
 #include <string>
 #include <list>
 
-/// Class which describes a one property
+/*!
+ * \class Config_Prop
+ * \brief Class which describes a one property
+ * \ingroup Config
+ */
 class Config_Prop
 {
  public:

diff --git a/src/Config/Config_PropManager.h b/src/Config/Config_PropManager.h
index a875fbf6ffa4a858e07c450ea6e1e8b75d9cbc4a..2d2facf5836e709e8ef2a603b84933ada6d62fa0 100644 (file)
--- a/src/Config/Config_PropManager.h
+++ b/src/Config/Config_PropManager.h
@@ -14,7 +14,11 @@
 #include <string>
 #include <vector>
 
-//! Class which let to register properties
+/*
+ * \class Config_PropManager
+ * \ingroup Config
+ * \brief Class which let to register properties
+ */
 class Config_PropManager
 {
  public:

diff --git a/src/Config/Config_SelectionFilterMessage.h b/src/Config/Config_SelectionFilterMessage.h
index 1d3e6d98d2452a8f64148a0ee274208d45b9d5d8..3f4039e73658d37b4072b49780dc5ad482a390e6 100644 (file)
--- a/src/Config/Config_SelectionFilterMessage.h
+++ b/src/Config/Config_SelectionFilterMessage.h
@@ -21,6 +21,7 @@ static const char * EVENT_SELFILTER_LOADED = "SelectionFilterLoaded";
 
 /*!
  * \class Config_SelectionFilterMessage
+ * \ingroup Config
  * \brief Transmits info about selection filters on "SelectionFilterLoaded" event
  */
 class Config_SelectionFilterMessage : public Events_Message

diff --git a/src/Config/Config_ValidatorMessage.h b/src/Config/Config_ValidatorMessage.h
index a0e410c153b1978a652946d8acd477b2eca3348f..e21b1f9fd3570496815caa3234abed6e415d163a 100644 (file)
--- a/src/Config/Config_ValidatorMessage.h
+++ b/src/Config/Config_ValidatorMessage.h
@@ -21,6 +21,7 @@ static const char * EVENT_VALIDATOR_LOADED = "ValidatorLoaded";
 
 /*!
  * \class Config_ValidatorMessage
+ * \ingroup Config
  * \brief Transmits info about created validator on "ValidatorLoaded" event
  */
 class Config_ValidatorMessage : public Events_Message

diff --git a/src/Config/Config_WidgetAPI.h b/src/Config/Config_WidgetAPI.h
index fa11e44e1ffb282c962d7675a3164bfbb08de84e..a44ce55a42cae5ab7ee18d7469b7d7e6fdcb258e 100644 (file)
--- a/src/Config/Config_WidgetAPI.h
+++ b/src/Config/Config_WidgetAPI.h
@@ -29,6 +29,7 @@ struct _xmlDoc;
 
 /*!
  * \class Config_WidgetAPI
+ * \ingroup Config
  * \brief Provides low-level API for WidgetFactory for reading xml definitions of widgets
  */
 class CONFIG_EXPORT Config_WidgetAPI

diff --git a/src/Config/Config_WidgetReader.h b/src/Config/Config_WidgetReader.h
index f36f95140b5e88893c354995853cbea354124a2c..339b3ad21f4831a3458f829069a6936bf26e7a22 100644 (file)
--- a/src/Config/Config_WidgetReader.h
+++ b/src/Config/Config_WidgetReader.h
@@ -18,6 +18,7 @@
 
 /*!
  * \class Config_WidgetReader
+ * \ingroup Config
  * \brief Class that dumps xml definitions of widgets for
  * further processing in the WidgetFactory
  */