From: dbv Date: Fri, 18 Sep 2015 06:48:16 +0000 (+0300) Subject: Documentation fixes. X-Git-Tag: V_1.4.0~21^2~2 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=de65be6c9f19bdf26ecb91fd3afd51c4d54e8d4a;p=modules%2Fshaper.git Documentation fixes. --- diff --git a/src/FeaturesPlugin/FeaturesPlugin_CompositeBoolean.h b/src/FeaturesPlugin/FeaturesPlugin_CompositeBoolean.h index be179ac7d..af2b1cae9 100644 --- a/src/FeaturesPlugin/FeaturesPlugin_CompositeBoolean.h +++ b/src/FeaturesPlugin/FeaturesPlugin_CompositeBoolean.h @@ -15,6 +15,7 @@ /** \class FeaturesPlugin_CompositeBoolean * \ingroup Plugins + * \brief Interface for the composite boolean feature. */ class FeaturesPlugin_CompositeBoolean : public ModelAPI_CompositeFeature { @@ -79,6 +80,7 @@ protected: ListOfShape& theResults, std::list>& theAlgos) = 0; + /// Results naming. void loadNamingDS(std::shared_ptr theResultBody, const std::shared_ptr& theBaseShape, const ListOfShape& theShells, @@ -87,6 +89,7 @@ protected: const GeomAlgoAPI_Boolean& theAlgo); protected: + /// Type of boolean operation. GeomAlgoAPI_Boolean::OperationType myBooleanOperationType; }; diff --git a/src/FeaturesPlugin/FeaturesPlugin_CompositeSketch.h b/src/FeaturesPlugin/FeaturesPlugin_CompositeSketch.h index ed3f32437..806a004cd 100644 --- a/src/FeaturesPlugin/FeaturesPlugin_CompositeSketch.h +++ b/src/FeaturesPlugin/FeaturesPlugin_CompositeSketch.h @@ -15,6 +15,7 @@ /** \class FeaturesPlugin_CompositeSketch * \ingroup Plugins + * \brief Interface for the composite sketch feature. */ class FeaturesPlugin_CompositeSketch : public ModelAPI_CompositeFeature { @@ -75,6 +76,7 @@ protected: std::shared_ptr& theMakeShape, std::shared_ptr& theDataMap) = 0; + /// Results naming. void loadNamingDS(std::shared_ptr theResultBody, const std::shared_ptr& theBaseShape, const std::shared_ptr& theResult, diff --git a/src/FeaturesPlugin/FeaturesPlugin_ExtrusionBoolean.h b/src/FeaturesPlugin/FeaturesPlugin_ExtrusionBoolean.h index 6ae91aeec..c8962430d 100644 --- a/src/FeaturesPlugin/FeaturesPlugin_ExtrusionBoolean.h +++ b/src/FeaturesPlugin/FeaturesPlugin_ExtrusionBoolean.h @@ -11,6 +11,7 @@ /** \class FeaturesPlugin_ExtrusionBoolean * \ingroup Plugins + * \brief Interface for the composite extrusion feature. */ class FeaturesPlugin_ExtrusionBoolean : public FeaturesPlugin_CompositeBoolean { diff --git a/src/FeaturesPlugin/FeaturesPlugin_ExtrusionCut.h b/src/FeaturesPlugin/FeaturesPlugin_ExtrusionCut.h index 54937b150..fd78e8f6d 100755 --- a/src/FeaturesPlugin/FeaturesPlugin_ExtrusionCut.h +++ b/src/FeaturesPlugin/FeaturesPlugin_ExtrusionCut.h @@ -11,6 +11,8 @@ /** \class FeaturesPlugin_ExtrusionCut * \ingroup Plugins + * \brief This feature allows to create sketch, extrude faces from this sketch and + * cut result from other objects in a single operation. */ class FeaturesPlugin_ExtrusionCut : public FeaturesPlugin_ExtrusionBoolean { diff --git a/src/FeaturesPlugin/FeaturesPlugin_ExtrusionFuse.h b/src/FeaturesPlugin/FeaturesPlugin_ExtrusionFuse.h index e3c2ed9e2..706e770db 100644 --- a/src/FeaturesPlugin/FeaturesPlugin_ExtrusionFuse.h +++ b/src/FeaturesPlugin/FeaturesPlugin_ExtrusionFuse.h @@ -11,6 +11,8 @@ /** \class FeaturesPlugin_ExtrusionFuse * \ingroup Plugins + * \brief This feature allows to create sketch, extrude faces from this sketch and + * fuse result with other objects in a single operation. */ class FeaturesPlugin_ExtrusionFuse : public FeaturesPlugin_ExtrusionBoolean { diff --git a/src/FeaturesPlugin/FeaturesPlugin_ExtrusionSketch.h b/src/FeaturesPlugin/FeaturesPlugin_ExtrusionSketch.h index f9db7e535..71e934aca 100644 --- a/src/FeaturesPlugin/FeaturesPlugin_ExtrusionSketch.h +++ b/src/FeaturesPlugin/FeaturesPlugin_ExtrusionSketch.h @@ -11,6 +11,8 @@ /** \class FeaturesPlugin_ExtrusionSketch * \ingroup Plugins + * \brief This feature allows to create sketch and extrude faces from this sketch + * in a single operation. */ class FeaturesPlugin_ExtrusionSketch : public FeaturesPlugin_CompositeSketch { diff --git a/src/FeaturesPlugin/FeaturesPlugin_RevolutionBoolean.h b/src/FeaturesPlugin/FeaturesPlugin_RevolutionBoolean.h index ce01edd80..16862065f 100644 --- a/src/FeaturesPlugin/FeaturesPlugin_RevolutionBoolean.h +++ b/src/FeaturesPlugin/FeaturesPlugin_RevolutionBoolean.h @@ -11,6 +11,7 @@ /** \class FeaturesPlugin_RevolutionBoolean * \ingroup Plugins + * \brief Interface for the composite revolution feature. */ class FeaturesPlugin_RevolutionBoolean : public FeaturesPlugin_CompositeBoolean { diff --git a/src/FeaturesPlugin/FeaturesPlugin_RevolutionCut.h b/src/FeaturesPlugin/FeaturesPlugin_RevolutionCut.h index f5a79a11a..3c1340262 100644 --- a/src/FeaturesPlugin/FeaturesPlugin_RevolutionCut.h +++ b/src/FeaturesPlugin/FeaturesPlugin_RevolutionCut.h @@ -11,6 +11,8 @@ /** \class FeaturesPlugin_RevolutionCut * \ingroup Plugins + * \brief This feature allows to create sketch, revol faces from this sketch and + * cut result from other objects in a single operation. */ class FeaturesPlugin_RevolutionCut : public FeaturesPlugin_RevolutionBoolean { diff --git a/src/FeaturesPlugin/FeaturesPlugin_RevolutionFuse.h b/src/FeaturesPlugin/FeaturesPlugin_RevolutionFuse.h index cf957781b..75f16aa67 100644 --- a/src/FeaturesPlugin/FeaturesPlugin_RevolutionFuse.h +++ b/src/FeaturesPlugin/FeaturesPlugin_RevolutionFuse.h @@ -11,6 +11,8 @@ /** \class FeaturesPlugin_RevolutionFuse * \ingroup Plugins + * \brief This feature allows to create sketch, revol faces from this sketch and + * fuse result with other objects in a single operation. */ class FeaturesPlugin_RevolutionFuse : public FeaturesPlugin_RevolutionBoolean { diff --git a/src/FeaturesPlugin/FeaturesPlugin_RevolutionSketch.h b/src/FeaturesPlugin/FeaturesPlugin_RevolutionSketch.h index b211c9222..fe914cc5d 100644 --- a/src/FeaturesPlugin/FeaturesPlugin_RevolutionSketch.h +++ b/src/FeaturesPlugin/FeaturesPlugin_RevolutionSketch.h @@ -11,6 +11,8 @@ /** \class FeaturesPlugin_RevolutionSketch * \ingroup Plugins + * \brief This feature allows to create sketch and revol faces from this sketch + * in a single operation. */ class FeaturesPlugin_RevolutionSketch : public FeaturesPlugin_CompositeSketch { diff --git a/src/FeaturesPlugin/FeaturesPlugin_ValidatorTransform.h b/src/FeaturesPlugin/FeaturesPlugin_ValidatorTransform.h index b1bb5c256..b957253e3 100755 --- a/src/FeaturesPlugin/FeaturesPlugin_ValidatorTransform.h +++ b/src/FeaturesPlugin/FeaturesPlugin_ValidatorTransform.h @@ -9,16 +9,18 @@ #include "ModelAPI_AttributeValidator.h" -/** -* \ingroup Validators -* A validator of selection -*/ +/** \class FeaturesPlugin_ValidatorTransform + * \ingroup Validators + * \brief A validator of selection + */ class FeaturesPlugin_ValidatorTransform : public ModelAPI_AttributeValidator { public: - //! returns true if attribute is valid - //! \param theAttribute the checked attribute - //! \param theArguments arguments of the attribute + /** \return true if attribute is valid + * \param theAttribute the checked attribute + * \param theArguments arguments of the attribute + * \param theError error message + */ virtual bool isValid(const AttributePtr& theAttribute, const std::list& theArguments, std::string& theError) const; diff --git a/src/GeomAPI/GeomAPI_Circ.h b/src/GeomAPI/GeomAPI_Circ.h index 3791071dd..32cac8968 100644 --- a/src/GeomAPI/GeomAPI_Circ.h +++ b/src/GeomAPI/GeomAPI_Circ.h @@ -51,8 +51,9 @@ class GeomAPI_Circ : public GeomAPI_Interface * at a distance less than the tolerance value. Return FALSE if the point * is beyond the tolerance limit or if computation fails. * Max Tolerance value is currently limited to 1.e-4 - * \param[in] theOrigin point of origin. - * \param[in] theDir direction of axis. + * \param[in] thePoint point of origin. + * \param[in] theTolerance tolerance of computation. + * \param[out] theParameter resulting parameter. */ GEOMAPI_EXPORT const bool parameter(const std::shared_ptr thePoint, const double theTolerance, diff --git a/src/GeomAPI/GeomAPI_ICustomPrs.h b/src/GeomAPI/GeomAPI_ICustomPrs.h index de9c6d299..2c2520ba9 100644 --- a/src/GeomAPI/GeomAPI_ICustomPrs.h +++ b/src/GeomAPI/GeomAPI_ICustomPrs.h @@ -12,12 +12,14 @@ #include "GeomAPI_AISObject.h" #include -/** -* Interface of a class which can provide specific customization of -* object presentation -*/ + class ModelAPI_Result; +/** \class GeomAPI_ICustomPrs + * \ingroup DataModel + * \brief Interface of a class which can provide specific customization of + * object presentation + */ class GeomAPI_ICustomPrs { public: diff --git a/src/GeomAPI/GeomAPI_PlanarEdges.h b/src/GeomAPI/GeomAPI_PlanarEdges.h index c26ad2505..9ba13cd1a 100644 --- a/src/GeomAPI/GeomAPI_PlanarEdges.h +++ b/src/GeomAPI/GeomAPI_PlanarEdges.h @@ -57,7 +57,6 @@ class GeomAPI_PlanarEdges : public GeomAPI_Shape /// Set working plane /// \param theOrigin origin of the plane axis /// \param theDirX X direction of the plane axis - /// \param theDirY Y direction of the plane axis /// \param theNorm normal direction of the plane axis GEOMAPI_EXPORT void setPlane(const std::shared_ptr& theOrigin, const std::shared_ptr& theDirX, diff --git a/src/GeomAPI/GeomAPI_ShapeExplorer.h b/src/GeomAPI/GeomAPI_ShapeExplorer.h index 29136a0cb..44320fa64 100644 --- a/src/GeomAPI/GeomAPI_ShapeExplorer.h +++ b/src/GeomAPI/GeomAPI_ShapeExplorer.h @@ -24,8 +24,9 @@ public: /** \brief Constructs an explorer to search on theShape, for shapes of type toFind, * that are not part of a shape toAvoid. If the shape toAvoid is equal to GeomAPI_SHape::SHAPE, * or if it is the same as, or less complex than the shape toFind it has no effect on the search. - \param[in] toFind shape type to find. - \param[in] toAvoid shape type to avoid. + * \param[in] theShape shape to explore. + * \param[in] toFind shape type to find. + * \param[in] toAvoid shape type to avoid. */ GEOMAPI_EXPORT GeomAPI_ShapeExplorer(const std::shared_ptr& theShape, @@ -35,8 +36,9 @@ public: /** \brief Resets this explorer. It is initialized to search on theShape, for shapes of type toFind, * that are not part of a shape toAvoid. If the shape toAvoid is equal to GeomAPI_SHape::SHAPE, * or if it is the same as, or less complex than the shape toFind it has no effect on the search. - \param[in] toFind shape type to find. - \param[in] toAvoid shape type to avoid. + * \param[in] theShape shape to explore. + * \param[in] toFind shape type to find. + * \param[in] toAvoid shape type to avoid. */ GEOMAPI_EXPORT void init(const std::shared_ptr& theShape, diff --git a/src/GeomAlgoAPI/GeomAlgoAPI_Boolean.h b/src/GeomAlgoAPI/GeomAlgoAPI_Boolean.h index 1c3655d9b..86e6dc9b8 100644 --- a/src/GeomAlgoAPI/GeomAlgoAPI_Boolean.h +++ b/src/GeomAlgoAPI/GeomAlgoAPI_Boolean.h @@ -23,10 +23,11 @@ class GeomAlgoAPI_Boolean : public GeomAPI_Interface { public: + /// Type of booelan operation enum OperationType{ - BOOL_CUT, - BOOL_FUSE, - BOOL_COMMON + BOOL_CUT, ///< Cut objects + BOOL_FUSE, ///< Fuse objects + BOOL_COMMON ///< Take common part of objects }; public: diff --git a/src/GeomAlgoAPI/GeomAlgoAPI_MakeShape.h b/src/GeomAlgoAPI/GeomAlgoAPI_MakeShape.h index a4c19e8c2..b4e46e54a 100644 --- a/src/GeomAlgoAPI/GeomAlgoAPI_MakeShape.h +++ b/src/GeomAlgoAPI/GeomAlgoAPI_MakeShape.h @@ -53,10 +53,10 @@ protected: GEOMALGOAPI_EXPORT GeomAlgoAPI_MakeShape(){}; protected: - GeomAlgoAPI_MakeShape::AlgoType myAlgoType; - std::shared_ptr myShape; - std::shared_ptr myWire; - std::shared_ptr myBaseShape; + GeomAlgoAPI_MakeShape::AlgoType myAlgoType; ///< Type of make shape algo. + std::shared_ptr myShape; ///< Resulting shape. + std::shared_ptr myWire; ///< Wire for pipe algo. + std::shared_ptr myBaseShape; ///< Base shape of algo. }; typedef std::list > ListOfMakeShape; diff --git a/src/GeomAlgoAPI/GeomAlgoAPI_MakeShapeList.h b/src/GeomAlgoAPI/GeomAlgoAPI_MakeShapeList.h index 6b6682c1c..0ba480907 100644 --- a/src/GeomAlgoAPI/GeomAlgoAPI_MakeShapeList.h +++ b/src/GeomAlgoAPI/GeomAlgoAPI_MakeShapeList.h @@ -68,7 +68,7 @@ private: protected: - ListOfMakeShape myListOfMakeShape; + ListOfMakeShape myListOfMakeShape; ///< List of make shape algos. }; #endif diff --git a/src/GeomAlgoAPI/GeomAlgoAPI_Revolution.h b/src/GeomAlgoAPI/GeomAlgoAPI_Revolution.h index c3562f75a..2484fcee1 100644 --- a/src/GeomAlgoAPI/GeomAlgoAPI_Revolution.h +++ b/src/GeomAlgoAPI/GeomAlgoAPI_Revolution.h @@ -34,6 +34,7 @@ class GeomAlgoAPI_Revolution : public GeomAPI_Interface public: /** \brief Creates revolution for the given shape. * \param[in] theBasis face for revolution. + * \param[in] theAxis axis for revolution. * \param[in] theToAngle to angle. * \param[in] theFromAngle from angle. */ @@ -44,6 +45,7 @@ public: /** \brief Creates revolution for the given shape. * \param[in] theBasis face for revolution. + * \param[in] theAxis axis for revolution. * \param[in] theToShape to bounding shape. Can be empty. In this case offset will be applied to the basis. * \param[in] theToAngle to angle. * \param[in] theFromShape from bounding shape. Can be empty. In this case offset will be applied to the basis. diff --git a/src/GeomAlgoAPI/GeomAlgoAPI_ShapeTools.h b/src/GeomAlgoAPI/GeomAlgoAPI_ShapeTools.h index fa792b2d6..c367d6867 100644 --- a/src/GeomAlgoAPI/GeomAlgoAPI_ShapeTools.h +++ b/src/GeomAlgoAPI/GeomAlgoAPI_ShapeTools.h @@ -15,7 +15,7 @@ /** \class GeomAlgoAPI_ShapeTools * \ingroup DataAlgo - * \brief + * \brief Useful tools for working with shapes. */ class GEOMALGOAPI_EXPORT GeomAlgoAPI_ShapeTools { @@ -30,8 +30,8 @@ public: /** \brief Combines faces with common edges to shells, or solids to compsolids. * \param[in] theCompound compound of shapes. * \param[in] theType type of combine. - * \param[out] theShells resulting shells. - * \param[out] theFreeFaces faces that does not have common edges. + * \param[out] theCombinedShapes resulting shapes. + * \param[out] theFreeShapes shapes that does not have common subshapes. */ static void combineShapes(const std::shared_ptr theCompound, const GeomAPI_Shape::ShapeType theType, diff --git a/src/GeomAlgoAPI/GeomAlgoAPI_SketchBuilder.h b/src/GeomAlgoAPI/GeomAlgoAPI_SketchBuilder.h index a4da606b1..f442df89d 100644 --- a/src/GeomAlgoAPI/GeomAlgoAPI_SketchBuilder.h +++ b/src/GeomAlgoAPI/GeomAlgoAPI_SketchBuilder.h @@ -26,7 +26,6 @@ class GEOMALGOAPI_EXPORT GeomAlgoAPI_SketchBuilder /** \brief Creates list of faces and unclosed wires on basis of the features of the sketch * \param[in] theOrigin origin point of the sketch * \param[in] theDirX x-direction of the sketch - * \param[in] theDirY y-direction of the sketch * \param[in] theNorm normal of the sketch * \param[in] theFeatures initial features of the sketch * \param[out] theResultFaces faces based on closed wires @@ -46,7 +45,6 @@ class GEOMALGOAPI_EXPORT GeomAlgoAPI_SketchBuilder /** \brief Creates list of faces and unclosed wires on basis of the features of the sketch * \param[in] theOrigin origin point of the sketch * \param[in] theDirX x-direction of the sketch - * \param[in] theDirY y-direction of the sketch * \param[in] theNorm normal of the sketch * \param[in] theWire a wire which contains all edges * \param[out] theResultFaces faces based on closed wires diff --git a/src/GeomAlgoAPI/GeomAlgoAPI_Tools.h b/src/GeomAlgoAPI/GeomAlgoAPI_Tools.h index fa950240e..7877f7028 100644 --- a/src/GeomAlgoAPI/GeomAlgoAPI_Tools.h +++ b/src/GeomAlgoAPI/GeomAlgoAPI_Tools.h @@ -13,6 +13,10 @@ namespace GeomAlgoAPI_Tools { +/** \class Localizer + * \ingroup DataAlgo + * \brief Localizer tool. + */ class Localizer { public: @@ -22,6 +26,10 @@ private: std::string myCurLocale; }; +/** \class File_Tools + * \ingroup DataAlgo + * \brief File tool. + */ class File_Tools { public: /** diff --git a/src/GeomValidators/GeomValidators_ZeroOffset.h b/src/GeomValidators/GeomValidators_ZeroOffset.h index e6897060a..91c7dcad9 100644 --- a/src/GeomValidators/GeomValidators_ZeroOffset.h +++ b/src/GeomValidators/GeomValidators_ZeroOffset.h @@ -21,7 +21,7 @@ public: /** \brief Returns true if feature and/or attributes are valid. * \param[in] theFeature the validated feature. * \param[in] theArguments the arguments in the configuration file for this validator. - * \returns true if feature is valid. + * \return true if feature is valid. */ GEOMVALIDATORS_EXPORT virtual bool isValid(const std::shared_ptr& theFeature, const std::list& theArguments,