Salome HOME
The minor corrections in the doxygen documentation
authormpv <mpv@opencascade.com>
Thu, 29 Jan 2015 13:08:04 +0000 (16:08 +0300)
committermpv <mpv@opencascade.com>
Thu, 29 Jan 2015 13:08:04 +0000 (16:08 +0300)
doc/Modules.doc
src/Config/Config_ModuleReader.h
src/Config/Config_PropManager.h
src/PartSetPlugin/PartSetPlugin_Plugin.h

index e891e1cc05e69f2015efe505c74189b166748057..71060e595a7be054a67c4a1d413bdfe22c8a02b1 100644 (file)
@@ -47,7 +47,7 @@
 /**
  * \defgroup GUI GUI of the application
  *
- * \brief Classes for griphic user interface definition
+ * \brief Classes for graphic user interface definition
  * 
  * Classes of application windows definition, operations launching, 
  * and objects presentations. It consists of two packages:
index f10762597e565c7113f3952839bcee978b9a9741..a6f8c1e2d4215565dc67b3e9afc059e1a5377e32 100644 (file)
@@ -39,7 +39,7 @@ class Config_ModuleReader : public Config_XMLReader
   /// Returns map that describes which file contains a feature (the feature is key, the file is value)
   CONFIG_EXPORT const std::map<std::string, std::string>& featuresInFiles() const;
   /// Returns module name: an xml attribute from the root of the plugins.xml:
-  /// e.g <plugins module="PartSet">
+  /// e.g \code <plugins module="PartSet"> \endcode 
   CONFIG_EXPORT std::string getModuleName();
   /// Detects type of the given plugin and loads it using loadLibrary or loadScript.
   CONFIG_EXPORT static void loadPlugin(const std::string& thePluginName);
index 2d2facf5836e709e8ef2a603b84933ada6d62fa0..751e3f44618be83535da73368f5e6504f83768f8 100644 (file)
@@ -14,7 +14,7 @@
 #include <string>
 #include <vector>
 
-/*
+/**
  * \class Config_PropManager
  * \ingroup Config
  * \brief Class which let to register properties
index 59ace5aa844925d932003f95b08eb89d41727d25..834c7c8a306b487271467ca9bef55574edb1475f 100644 (file)
@@ -16,7 +16,7 @@
 
 #include <memory>
 
-/**\class FeaturesPlugin_Plugin
+/**\class PartSetPlugin_Plugin
  * \ingroup Plugins
  * \brief The main class for management the part set operations as plugin.
  */
@@ -32,6 +32,8 @@ class PARTSETPLUGIN_EXPORT PartSetPlugin_Plugin : public ModelAPI_Plugin,
 
   //! Redefinition of Events_Listener method
   virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage);
+  //! Performs the chenges of enabled/disabled state in the toolbar
+  //! due to the current state of the application.
   std::shared_ptr<ModelAPI_FeatureStateMessage> getFeaturesState();
 };