From 2993f57fa33a1d58dce1d772ea15aa0f5ddf33e8 Mon Sep 17 00:00:00 2001 From: mpv Date: Thu, 29 Jan 2015 16:08:04 +0300 Subject: [PATCH] The minor corrections in the doxygen documentation --- doc/Modules.doc | 2 +- src/Config/Config_ModuleReader.h | 2 +- src/Config/Config_PropManager.h | 2 +- src/PartSetPlugin/PartSetPlugin_Plugin.h | 4 +++- 4 files changed, 6 insertions(+), 4 deletions(-) diff --git a/doc/Modules.doc b/doc/Modules.doc index e891e1cc0..71060e595 100644 --- a/doc/Modules.doc +++ b/doc/Modules.doc @@ -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: diff --git a/src/Config/Config_ModuleReader.h b/src/Config/Config_ModuleReader.h index f10762597..a6f8c1e2d 100644 --- a/src/Config/Config_ModuleReader.h +++ b/src/Config/Config_ModuleReader.h @@ -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& featuresInFiles() const; /// Returns module name: an xml attribute from the root of the plugins.xml: - /// e.g + /// e.g \code \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); diff --git a/src/Config/Config_PropManager.h b/src/Config/Config_PropManager.h index 2d2facf58..751e3f446 100644 --- a/src/Config/Config_PropManager.h +++ b/src/Config/Config_PropManager.h @@ -14,7 +14,7 @@ #include #include -/* +/** * \class Config_PropManager * \ingroup Config * \brief Class which let to register properties diff --git a/src/PartSetPlugin/PartSetPlugin_Plugin.h b/src/PartSetPlugin/PartSetPlugin_Plugin.h index 59ace5aa8..834c7c8a3 100644 --- a/src/PartSetPlugin/PartSetPlugin_Plugin.h +++ b/src/PartSetPlugin/PartSetPlugin_Plugin.h @@ -16,7 +16,7 @@ #include -/**\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& theMessage); + //! Performs the chenges of enabled/disabled state in the toolbar + //! due to the current state of the application. std::shared_ptr getFeaturesState(); }; -- 2.39.2