]> SALOME platform Git repositories - modules/shaper.git/commitdiff
Salome HOME
Documentation fixes.
authorspo <sergey.pokhodenko@opencascade.com>
Fri, 18 Sep 2015 10:29:45 +0000 (13:29 +0300)
committerspo <sergey.pokhodenko@opencascade.com>
Fri, 18 Sep 2015 10:29:45 +0000 (13:29 +0300)
src/ExchangePlugin/ExchangePlugin_ExportFeature.h
src/ExchangePlugin/ExchangePlugin_ImportFeature.h
src/ExchangePlugin/ExchangePlugin_Plugin.h
src/ExchangePlugin/ExchangePlugin_Tools.h
src/ExchangePlugin/ExchangePlugin_Validators.h
src/ParametersPlugin/ParametersPlugin_Parameter.h
src/ParametersPlugin/ParametersPlugin_PyInterp.h
src/ParametersPlugin/ParametersPlugin_Validators.h

index f5c27d0daa574d4af7a0200d25cd5748fcd614d6..87727711e52951cf0e18d2a57dce317c1cc04a0e 100644 (file)
@@ -18,7 +18,7 @@
  * \ingroup Plugins
  * \brief Feature for export shapes to the external files in CAD formats.
  *
- * The set of supported formats is defined in the configuration file.
+ * The list of supported formats is defined in the configuration file.
  */
 class ExchangePlugin_ExportFeature : public ModelAPI_Feature
 {
@@ -47,9 +47,9 @@ public:
     static const std::string MY_SELECTION_LIST_ID("selection_list");
     return MY_SELECTION_LIST_ID;
   }
-  /// default constructor
+  /// Default constructor
   EXCHANGEPLUGIN_EXPORT ExchangePlugin_ExportFeature();
-  /// default destructor
+  /// Default destructor
   EXCHANGEPLUGIN_EXPORT virtual ~ExchangePlugin_ExportFeature();
 
   /// Request for initialization of data model of the feature: adding all attributes
index afb436b19e2d34951b9a3c0f39c4b8d54e020f8a..d7cf695b438675fe9afb7454f1929f84d55e1e04 100644 (file)
@@ -18,7 +18,7 @@
  * \ingroup Plugins
  * \brief Feature for import shapes from the external files in CAD formats.
  *
- * The set of supported formats is defined in the configuration file.
+ * The list of supported formats is defined in the configuration file.
  */
 class ExchangePlugin_ImportFeature : public ModelAPI_Feature
 {
@@ -29,15 +29,15 @@ class ExchangePlugin_ImportFeature : public ModelAPI_Feature
     static const std::string MY_IMPORT_ID("Import");
     return MY_IMPORT_ID;
   }
-  /// attribute name of referenced face
+  /// attribute name of file path
   inline static const std::string& FILE_PATH_ID()
   {
     static const std::string MY_FILE_PATH_ID("file_path");
     return MY_FILE_PATH_ID;
   }
-  /// default constructor
+  /// Default constructor
   EXCHANGEPLUGIN_EXPORT ExchangePlugin_ImportFeature();
-  /// default destructor
+  /// Default destructor
   EXCHANGEPLUGIN_EXPORT virtual ~ExchangePlugin_ImportFeature();
 
   /// Returns the unique kind of a feature
index 6f8aa0200c0955d6585d0ae748a48a9f3b79f282..ba497f466106c932e1e4d5dde1dc7fd4e36b605f 100644 (file)
@@ -14,7 +14,7 @@
 /**
  * \class ExchangePlugin_Plugin
  * \ingroup Plugins
- * \brief The main class for management the import and export operations as plugin.
+ * \brief The main class for management import and export operations as plugin.
  */
 class EXCHANGEPLUGIN_EXPORT ExchangePlugin_Plugin : public ModelAPI_Plugin
 {
index dc82532665653eaadd80b804bf82b5aaf23b798c..58d0dd19fd26b47815aa0eee85511a8c1679563c 100644 (file)
@@ -14,8 +14,7 @@
 
 /**
  * \class ExchangePlugin_Tools
- * \ingroup Plugins
- * \brief Internal tools for the plugin.
+ * \brief Internal tools for the ExchangePlugin.
  */
 class EXCHANGEPLUGIN_EXPORT ExchangePlugin_Tools {
 public:
index b4b6a437eea922e443293ca1072dbc7336ea4524..ab1a142f9a2fb72b2450307987189a4ff7c15388 100644 (file)
@@ -38,11 +38,21 @@ public:
                        std::string& theError) const;
 };
 
+/**
+ * \class ExchangePlugin_ImportFormatValidator
+ * \ingroup Validators
+ * \brief Validator for the import format.
+ */
 class ExchangePlugin_ImportFormatValidator : public ExchangePlugin_FormatValidator
 {
 
 };
 
+/**
+ * \class ExchangePlugin_ExportFormatValidator
+ * \ingroup Validators
+ * \brief Validator for the export format.
+ */
 class ExchangePlugin_ExportFormatValidator : public ExchangePlugin_FormatValidator
 {
 
index 2eef33febd518e7d58328f4c2b106a98f8220beb..229f8f217192cb95b68fcc2ee18a9f377b490708 100644 (file)
@@ -65,14 +65,16 @@ class ParametersPlugin_Parameter : public ModelAPI_Feature
   /// Pre-execution is not needed for parameter
   PARAMETERSPLUGIN_EXPORT virtual bool isPreviewNeeded() const;
 
-  /// Creates a new part document if needed
+  /// Creates a parameter in document
   PARAMETERSPLUGIN_EXPORT virtual void execute();
 
   /// Request for initialization of data model of the feature: adding all attributes
   PARAMETERSPLUGIN_EXPORT virtual void initAttributes();
 
-  PARAMETERSPLUGIN_EXPORT virtual bool isInHistory(); //false
+  /// Reimplemented from ModelAPI_Feature::isInHistory(). Returns false.
+  PARAMETERSPLUGIN_EXPORT virtual bool isInHistory();
 
+  /// Reimplemented from ModelAPI_Feature::isInHistory().
   PARAMETERSPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
 
   /// Use plugin manager for features creation
@@ -81,9 +83,9 @@ class ParametersPlugin_Parameter : public ModelAPI_Feature
  protected:
   /// Evaluates theExpression and returns its value.
   double evaluate(const std::string& theExpression, std::string& theError);
-  /// Update name of the parameter
+  /// Updates name of the parameter
   void updateName();
-  /// Update expression of the parameter
+  /// Updates expression of the parameter
   void updateExpression();
 
  private:
index 4d019556e65281796c01ac3e359886fd9edf176d..6764db13a2112c211243269215043921aee352ba 100644 (file)
@@ -29,9 +29,9 @@ class PARAMETERSPLUGIN_EXPORT ParametersPlugin_PyInterp : public PyInterp_Interp
   /// Returns a list of positions for theName in theExpression.
   std::list<std::pair<int, int> > positions(const std::string& theExpression,
                                             const std::string& theName);
-  /// Compiles theExpression and returns a list of parameters from theExpression.
+  /// Compiles theExpression and returns a list of parameters used in theExpression.
   std::list<std::string> compile(const std::string& theExpression);
-  /// Extends local context with the list of parameters with values.
+  /// Extends local context with the list of parameters.
   void extendLocalContext(const std::list<std::string>& theParameters);
   /// Clears local context.
   void clearLocalContext();
index a0551de61f8301321dbc62f086ee349eceaea5b4..cc1812abc711f87bad0424fdef8590ea2b8d5ce0 100644 (file)
@@ -26,18 +26,20 @@ class ParametersPlugin_VariableValidator : public ModelAPI_AttributeValidator
   PARAMETERSPLUGIN_EXPORT ParametersPlugin_VariableValidator();
   PARAMETERSPLUGIN_EXPORT virtual ~ParametersPlugin_VariableValidator();
 
-  //! returns true if attribute is valid
-  //! \param theAttribute the checked attribute
-  //! \param theArguments arguments of the attribute
-  //! \param theError the error string message if validation fails
+  /**
+   * \brief Returns true if attribute has a valid parameter name.
+   * \param theAttribute the checked attribute
+   * \param theArguments arguments of the attribute
+   * \param theError the error string message if validation fails
+   */
   PARAMETERSPLUGIN_EXPORT virtual bool isValid(const AttributePtr& theAttribute,
                                                const std::list<std::string>& theArguments,
                                                std::string& theError) const;
 
  protected:
-  /// Returns true if theString is a variable name.
+  /// Returns true if theString is a valid variable name.
   PARAMETERSPLUGIN_EXPORT bool isVariable(const std::string& theString) const;
-  /// Returns true if theString is unique parameter name for theAttribute context.
+  /// Returns true if theString is unique parameter name in the document of theAttribute.
   PARAMETERSPLUGIN_EXPORT bool isUnique(const AttributePtr& theAttribute,
                                         const std::string& theString) const;
 };
@@ -53,10 +55,12 @@ class ParametersPlugin_ExpressionValidator: public ModelAPI_AttributeValidator
   PARAMETERSPLUGIN_EXPORT ParametersPlugin_ExpressionValidator();
   PARAMETERSPLUGIN_EXPORT virtual ~ParametersPlugin_ExpressionValidator();
 
-  //! returns true if attribute is valid
-  //! \param theAttribute the checked attribute
-  //! \param theArguments arguments of the attribute
-  //! \param theError the error string message if validation fails
+  /**
+   * \brief Returns true if attribute has a valid parameter expression.
+   * \param theAttribute the checked attribute
+   * \param theArguments arguments of the attribute
+   * \param theError the error string message if validation fails
+   */
   PARAMETERSPLUGIN_EXPORT virtual bool isValid(const AttributePtr& theAttribute,
                                                const std::list<std::string>& theArguments,
                                                std::string& theError) const;