From: sbh <sergey.belash@opencascade.com>
Date: Wed, 28 Jan 2015 13:24:39 +0000 (+0300)
Subject: Describe config module in doxygen
X-Git-Tag: V_1.0.0~16
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=8e80972644fce257cd66382ae976e71e2d2e6c32;p=modules%2Fshaper.git

Describe config module in doxygen
---

diff --git a/doc/Modules.doc b/doc/Modules.doc
index 0b41bfe0b..e891e1cc0 100644
--- 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 a56d7253a..bfc63dd05 100644
--- a/src/Config/Config_FeatureMessage.h
+++ b/src/Config/Config_FeatureMessage.h
@@ -10,6 +10,7 @@
 
 /*!
  * \class Config_FeatureMessage
+ * \ingroup Config
  * \brief Class to pass a feature entry extracted from xml file.
  * Example of the feature entry:
  * \code
diff --git a/src/Config/Config_FeatureReader.h b/src/Config/Config_FeatureReader.h
index 7c0096ccd..7f7889aaa 100644
--- 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 655a6ca7a..f10762597 100644
--- 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 aafa6b036..872c43655 100644
--- 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 1cf0c0c53..fe64ca058 100644
--- 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 a875fbf6f..2d2facf58 100644
--- 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 1d3e6d98d..3f4039e73 100644
--- 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 a0e410c15..e21b1f9fd 100644
--- 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 fa11e44e1..a44ce55a4 100644
--- 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 f36f95140..339b3ad21 100644
--- 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
  */