From d8858e810a0b5e1d09a93fcaa665b439c4264873 Mon Sep 17 00:00:00 2001 From: spo Date: Fri, 18 Sep 2015 13:29:45 +0300 Subject: [PATCH] Documentation fixes. --- .../ExchangePlugin_ExportFeature.h | 6 ++--- .../ExchangePlugin_ImportFeature.h | 8 +++---- src/ExchangePlugin/ExchangePlugin_Plugin.h | 2 +- src/ExchangePlugin/ExchangePlugin_Tools.h | 3 +-- .../ExchangePlugin_Validators.h | 10 ++++++++ .../ParametersPlugin_Parameter.h | 10 ++++---- .../ParametersPlugin_PyInterp.h | 4 ++-- .../ParametersPlugin_Validators.h | 24 +++++++++++-------- 8 files changed, 41 insertions(+), 26 deletions(-) diff --git a/src/ExchangePlugin/ExchangePlugin_ExportFeature.h b/src/ExchangePlugin/ExchangePlugin_ExportFeature.h index f5c27d0da..87727711e 100644 --- a/src/ExchangePlugin/ExchangePlugin_ExportFeature.h +++ b/src/ExchangePlugin/ExchangePlugin_ExportFeature.h @@ -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 diff --git a/src/ExchangePlugin/ExchangePlugin_ImportFeature.h b/src/ExchangePlugin/ExchangePlugin_ImportFeature.h index afb436b19..d7cf695b4 100644 --- a/src/ExchangePlugin/ExchangePlugin_ImportFeature.h +++ b/src/ExchangePlugin/ExchangePlugin_ImportFeature.h @@ -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 diff --git a/src/ExchangePlugin/ExchangePlugin_Plugin.h b/src/ExchangePlugin/ExchangePlugin_Plugin.h index 6f8aa0200..ba497f466 100644 --- a/src/ExchangePlugin/ExchangePlugin_Plugin.h +++ b/src/ExchangePlugin/ExchangePlugin_Plugin.h @@ -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 { diff --git a/src/ExchangePlugin/ExchangePlugin_Tools.h b/src/ExchangePlugin/ExchangePlugin_Tools.h index dc8253266..58d0dd19f 100644 --- a/src/ExchangePlugin/ExchangePlugin_Tools.h +++ b/src/ExchangePlugin/ExchangePlugin_Tools.h @@ -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: diff --git a/src/ExchangePlugin/ExchangePlugin_Validators.h b/src/ExchangePlugin/ExchangePlugin_Validators.h index b4b6a437e..ab1a142f9 100644 --- a/src/ExchangePlugin/ExchangePlugin_Validators.h +++ b/src/ExchangePlugin/ExchangePlugin_Validators.h @@ -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 { diff --git a/src/ParametersPlugin/ParametersPlugin_Parameter.h b/src/ParametersPlugin/ParametersPlugin_Parameter.h index 2eef33feb..229f8f217 100644 --- a/src/ParametersPlugin/ParametersPlugin_Parameter.h +++ b/src/ParametersPlugin/ParametersPlugin_Parameter.h @@ -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: diff --git a/src/ParametersPlugin/ParametersPlugin_PyInterp.h b/src/ParametersPlugin/ParametersPlugin_PyInterp.h index 4d019556e..6764db13a 100644 --- a/src/ParametersPlugin/ParametersPlugin_PyInterp.h +++ b/src/ParametersPlugin/ParametersPlugin_PyInterp.h @@ -29,9 +29,9 @@ class PARAMETERSPLUGIN_EXPORT ParametersPlugin_PyInterp : public PyInterp_Interp /// Returns a list of positions for theName in theExpression. std::list > 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 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& theParameters); /// Clears local context. void clearLocalContext(); diff --git a/src/ParametersPlugin/ParametersPlugin_Validators.h b/src/ParametersPlugin/ParametersPlugin_Validators.h index a0551de61..cc1812abc 100644 --- a/src/ParametersPlugin/ParametersPlugin_Validators.h +++ b/src/ParametersPlugin/ParametersPlugin_Validators.h @@ -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& 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& theArguments, std::string& theError) const; -- 2.30.2