X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FConfig%2FConfig_WidgetReader.h;h=a95d8b805b154302decb362ca6c23d1111e5d2d5;hb=51f9a2d4ddb07cb536d1bfef694995b81e4079af;hp=55ce4e932b06183b0c8aa35ebc7bacb53af05539;hpb=cd9217d7e87997ec8bc150a6d8c389e742ca0f84;p=modules%2Fshaper.git

diff --git a/src/Config/Config_WidgetReader.h b/src/Config/Config_WidgetReader.h
index 55ce4e932..a95d8b805 100644
--- a/src/Config/Config_WidgetReader.h
+++ b/src/Config/Config_WidgetReader.h
@@ -1,3 +1,5 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 /*
  * Config_WidgetReader.h
  *
@@ -14,18 +16,35 @@
 #include <map>
 #include <string>
 
+/*!
+ * \class Config_WidgetReader
+ * \ingroup Config
+ * \brief Class that dumps xml definitions of widgets for
+ * further processing in the WidgetFactory
+ */
 class Config_WidgetReader : public Config_XMLReader
 {
  public:
-  CONFIG_EXPORT Config_WidgetReader(const std::string& theXmlFile);CONFIG_EXPORT virtual ~Config_WidgetReader();
-
-  CONFIG_EXPORT std::string featureWidgetCfg(const std::string& theFeatureName);CONFIG_EXPORT std::string featureDescription(
-      const std::string& theFeatureName);
+  /*!
+   * Constructor
+   * \param theXmlFile - full path to the xml file which will be processed by the reader
+   */
+  CONFIG_EXPORT Config_WidgetReader(const std::string& theXmlFile);
+  CONFIG_EXPORT virtual ~Config_WidgetReader();
+
+  /// Extract feature's widget configuration from local cache, stored on node processing
+  CONFIG_EXPORT std::string featureWidgetCfg(const std::string& theFeatureName);
+  /// Extract feature's description from local cache, stored on node processing
+  CONFIG_EXPORT std::string featureDescription(const std::string& theFeatureName);
 
  protected:
+  /// Overloaded method. Defines how to process each node
   void processNode(xmlNodePtr theNode);
+  /// Overloaded method. Defines if the given node should be parsed recursively
   bool processChildren(xmlNodePtr theNode);
+  /// Extracts xml definition of the given node and it's children
   std::string dumpNode(xmlNodePtr theNode);
+  /// Replace all "source" nodes with their content (used before dumping nodes)
   void resolveSourceNodes(xmlNodePtr theNode);
 
  private: