From: dbv Date: Thu, 8 Sep 2016 12:20:04 +0000 (+0300) Subject: Documentation update X-Git-Tag: V_2.5.0 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=73b293b1c77ab13ac9fbbb2aefb3b8573e63180b;p=modules%2Fshaper.git Documentation update --- diff --git a/src/FeaturesAPI/FeaturesAPI_ExtrusionBoolean.h b/src/FeaturesAPI/FeaturesAPI_ExtrusionBoolean.h index d5572cb4c..4894c5fc8 100644 --- a/src/FeaturesAPI/FeaturesAPI_ExtrusionBoolean.h +++ b/src/FeaturesAPI/FeaturesAPI_ExtrusionBoolean.h @@ -86,6 +86,9 @@ private: void execIfBaseNotEmpty(); }; +/// \class FeaturesAPI_ExtrusionCut +/// \ingroup CPPHighAPI +/// \brief Interface for ExtrusionCut feature. class FeaturesAPI_ExtrusionCut: public FeaturesAPI_ExtrusionBoolean { public: @@ -218,6 +221,9 @@ ExtrusionCutPtr addExtrusionCut(const std::shared_ptr& thePar const ModelHighAPI_Double& theFromOffset, const std::list& theBooleanObjects); +/// \class FeaturesAPI_ExtrusionFuse +/// \ingroup CPPHighAPI +/// \brief Interface for ExtrusionFuse feature. class FeaturesAPI_ExtrusionFuse: public FeaturesAPI_ExtrusionBoolean { public: diff --git a/src/FeaturesAPI/FeaturesAPI_RevolutionBoolean.h b/src/FeaturesAPI/FeaturesAPI_RevolutionBoolean.h index bc5942242..f4986ffd3 100644 --- a/src/FeaturesAPI/FeaturesAPI_RevolutionBoolean.h +++ b/src/FeaturesAPI/FeaturesAPI_RevolutionBoolean.h @@ -88,6 +88,9 @@ private: void execIfBaseNotEmpty(); }; +/// \class FeaturesAPI_RevolutionCut +/// \ingroup CPPHighAPI +/// \brief Interface for RevolutionCut feature. class FeaturesAPI_RevolutionCut: public FeaturesAPI_RevolutionBoolean { public: @@ -162,6 +165,9 @@ RevolutionCutPtr addRevolutionCut(const std::shared_ptr& theP const ModelHighAPI_Double& theFromOffset, const std::list& theBooleanObjects); +/// \class FeaturesAPI_RevolutionFuse +/// \ingroup CPPHighAPI +/// \brief Interface for RevolutionFuse feature. class FeaturesAPI_RevolutionFuse: public FeaturesAPI_RevolutionBoolean { public: diff --git a/src/FeaturesPlugin/FeaturesPlugin_Validators.h b/src/FeaturesPlugin/FeaturesPlugin_Validators.h index 64262768a..223519b77 100644 --- a/src/FeaturesPlugin/FeaturesPlugin_Validators.h +++ b/src/FeaturesPlugin/FeaturesPlugin_Validators.h @@ -202,9 +202,9 @@ class FeaturesPlugin_ValidatorUnionArguments: public ModelAPI_FeatureValidator virtual bool isNotObligatory(std::string theFeature, std::string theAttribute); }; -/// \class FeaturesPlugin_ValidatorUnionArguments +/// \class FeaturesPlugin_ValidatorConcealedResult /// \ingroup Validators -/// \brief Validator for the "Union" feature. +/// \brief Validator for the "Recover" feature. class FeaturesPlugin_ValidatorConcealedResult: public ModelAPI_AttributeValidator { public: diff --git a/src/GeomAPI/GeomAPI_Angle.cpp b/src/GeomAPI/GeomAPI_Angle.cpp index 60c3761a0..9849b9e9d 100644 --- a/src/GeomAPI/GeomAPI_Angle.cpp +++ b/src/GeomAPI/GeomAPI_Angle.cpp @@ -14,6 +14,8 @@ #include #include +/// \struct ThreePoints +/// \brief Used to store info about angle point and state. struct ThreePoints { gp_Pnt myCenter; gp_Pnt myFirst; diff --git a/src/GeomAPI/GeomAPI_Angle2d.cpp b/src/GeomAPI/GeomAPI_Angle2d.cpp index 2162de5d9..87fe12392 100644 --- a/src/GeomAPI/GeomAPI_Angle2d.cpp +++ b/src/GeomAPI/GeomAPI_Angle2d.cpp @@ -14,6 +14,8 @@ #include #include +/// \struct ThreePoints +/// \brief Used to store info about angle point and state. struct ThreePoints2d { gp_Pnt2d myCenter; gp_Pnt2d myFirst; diff --git a/src/ModelHighAPI/ModelHighAPI_Interface.h b/src/ModelHighAPI/ModelHighAPI_Interface.h index 43d267642..c6fa134bc 100644 --- a/src/ModelHighAPI/ModelHighAPI_Interface.h +++ b/src/ModelHighAPI/ModelHighAPI_Interface.h @@ -79,7 +79,7 @@ public: virtual void dump(ModelHighAPI_Dumper& theDumper) const {} protected: - std::shared_ptr myFeature; + std::shared_ptr myFeature; ///< feature of this interface std::map myAttrGetter; ///< names of attributes and their getters }; diff --git a/src/ModuleBase/ModuleBase_ModelDialogWidget.h b/src/ModuleBase/ModuleBase_ModelDialogWidget.h index 82a3a355b..121153df7 100644 --- a/src/ModuleBase/ModuleBase_ModelDialogWidget.h +++ b/src/ModuleBase/ModuleBase_ModelDialogWidget.h @@ -12,6 +12,9 @@ class QDialogButtonBox; +/// \class ModuleBase_ModelDialogWidget +/// \ingroup GUI +/// \brief Widget for dialog. class MODULEBASE_EXPORT ModuleBase_ModelDialogWidget : public ModuleBase_ModelWidget { Q_OBJECT diff --git a/src/PrimitivesAPI/PrimitivesAPI_Box.h b/src/PrimitivesAPI/PrimitivesAPI_Box.h index fc084964d..acf8bdffb 100644 --- a/src/PrimitivesAPI/PrimitivesAPI_Box.h +++ b/src/PrimitivesAPI/PrimitivesAPI_Box.h @@ -17,7 +17,7 @@ class ModelHighAPI_Double; class ModelHighAPI_Selection; -/// \class PrimitivesPlugin_Box +/// \class PrimitivesAPI_Box /// \ingroup CPPHighAPI /// \brief Interface for primitive Box feature. class PrimitivesAPI_Box: public ModelHighAPI_Interface diff --git a/src/SketchAPI/SketchAPI_Arc.h b/src/SketchAPI/SketchAPI_Arc.h index 5fc0e5b0d..92f24fb3e 100644 --- a/src/SketchAPI/SketchAPI_Arc.h +++ b/src/SketchAPI/SketchAPI_Arc.h @@ -17,7 +17,7 @@ class ModelHighAPI_RefAttr; class ModelHighAPI_Selection; -/// \class FeaturesAPI_Boolean +/// \class SketchAPI_Arc /// \ingroup CPPHighAPI /// \brief Interface for Arc feature. class SketchAPI_Arc: public SketchAPI_SketchEntity diff --git a/src/SketchAPI/SketchAPI_Circle.h b/src/SketchAPI/SketchAPI_Circle.h index 76c7f1fac..3c10b00c1 100644 --- a/src/SketchAPI/SketchAPI_Circle.h +++ b/src/SketchAPI/SketchAPI_Circle.h @@ -14,7 +14,7 @@ class ModelHighAPI_Selection; -/// \class FeaturesAPI_Boolean +/// \class SketchAPI_Circle /// \ingroup CPPHighAPI /// \brief Interface for Circle feature. class SketchAPI_Circle: public SketchAPI_SketchEntity diff --git a/src/SketchPlugin/SketchPlugin_ConstraintFillet.h b/src/SketchPlugin/SketchPlugin_ConstraintFillet.h index b1199bcb8..0f665a32f 100644 --- a/src/SketchPlugin/SketchPlugin_ConstraintFillet.h +++ b/src/SketchPlugin/SketchPlugin_ConstraintFillet.h @@ -25,6 +25,7 @@ class SketchPlugin_ConstraintFillet : public SketchPlugin_ConstraintBase { public: + /// \struct Struct to store base edges with states, result edges and constraints. struct FilletFeatures { std::list> baseEdgesState; ///< list of objects the fillet is based and its states std::list resultEdges; ///< list of result edges diff --git a/src/SketcherPrs/SketcherPrs_DimensionStyleListener.h b/src/SketcherPrs/SketcherPrs_DimensionStyleListener.h index 17a39b466..9d49b9e84 100755 --- a/src/SketcherPrs/SketcherPrs_DimensionStyleListener.h +++ b/src/SketcherPrs/SketcherPrs_DimensionStyleListener.h @@ -18,6 +18,7 @@ #include /** +* \class SketcherPrs_DimensionStyleListener * \ingroup GUI * A class for representation of linear dimension constraint. * It supports SketchPlugin_ConstraintLength and SketchPlugin_ConstraintDistance features.