]> SALOME platform Git repositories - modules/shaper.git/commitdiff
Salome HOME
Documentation fixes.
authordbv <dbv@opencascade.com>
Fri, 18 Sep 2015 06:48:16 +0000 (09:48 +0300)
committerdbv <dbv@opencascade.com>
Fri, 18 Sep 2015 06:48:16 +0000 (09:48 +0300)
23 files changed:
src/FeaturesPlugin/FeaturesPlugin_CompositeBoolean.h
src/FeaturesPlugin/FeaturesPlugin_CompositeSketch.h
src/FeaturesPlugin/FeaturesPlugin_ExtrusionBoolean.h
src/FeaturesPlugin/FeaturesPlugin_ExtrusionCut.h
src/FeaturesPlugin/FeaturesPlugin_ExtrusionFuse.h
src/FeaturesPlugin/FeaturesPlugin_ExtrusionSketch.h
src/FeaturesPlugin/FeaturesPlugin_RevolutionBoolean.h
src/FeaturesPlugin/FeaturesPlugin_RevolutionCut.h
src/FeaturesPlugin/FeaturesPlugin_RevolutionFuse.h
src/FeaturesPlugin/FeaturesPlugin_RevolutionSketch.h
src/FeaturesPlugin/FeaturesPlugin_ValidatorTransform.h
src/GeomAPI/GeomAPI_Circ.h
src/GeomAPI/GeomAPI_ICustomPrs.h
src/GeomAPI/GeomAPI_PlanarEdges.h
src/GeomAPI/GeomAPI_ShapeExplorer.h
src/GeomAlgoAPI/GeomAlgoAPI_Boolean.h
src/GeomAlgoAPI/GeomAlgoAPI_MakeShape.h
src/GeomAlgoAPI/GeomAlgoAPI_MakeShapeList.h
src/GeomAlgoAPI/GeomAlgoAPI_Revolution.h
src/GeomAlgoAPI/GeomAlgoAPI_ShapeTools.h
src/GeomAlgoAPI/GeomAlgoAPI_SketchBuilder.h
src/GeomAlgoAPI/GeomAlgoAPI_Tools.h
src/GeomValidators/GeomValidators_ZeroOffset.h

index be179ac7df97979d882bf382024bc5fcac3c5098..af2b1cae9cc41ab9b767c9956036ae68146e1ff6 100644 (file)
@@ -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<std::shared_ptr<GeomAPI_Interface>>& theAlgos) = 0;
 
+  /// Results naming.
   void loadNamingDS(std::shared_ptr<ModelAPI_ResultBody> theResultBody,
                     const std::shared_ptr<GeomAPI_Shape>& theBaseShape,
                     const ListOfShape& theShells,
@@ -87,6 +89,7 @@ protected:
                     const GeomAlgoAPI_Boolean& theAlgo);
 
 protected:
+  /// Type of boolean operation.
   GeomAlgoAPI_Boolean::OperationType myBooleanOperationType;
 };
 
index ed3f32437c4fee474c1ac717cc25c7130d86118a..806a004cd1770ce2467f592860615a93c939f1b1 100644 (file)
@@ -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<GeomAlgoAPI_MakeShape>& theMakeShape,
                          std::shared_ptr<GeomAPI_DataMapOfShapeShape>& theDataMap) = 0;
 
+  /// Results naming.
   void loadNamingDS(std::shared_ptr<ModelAPI_ResultBody> theResultBody,
                     const std::shared_ptr<GeomAPI_Shape>& theBaseShape,
                     const std::shared_ptr<GeomAPI_Shape>& theResult,
index 6ae91aeec7ded5744b9410fcdf504db90dddf639..c8962430dc775cf6ed2977aa15804bf2c7e2e98f 100644 (file)
@@ -11,6 +11,7 @@
 
 /** \class FeaturesPlugin_ExtrusionBoolean
  *  \ingroup Plugins
+ *  \brief Interface for the composite extrusion feature.
  */
 class FeaturesPlugin_ExtrusionBoolean : public FeaturesPlugin_CompositeBoolean
 {
index 54937b1503016a423d6548f9460f79175ab2aaf1..fd78e8f6d28fe6f6a425e90fb2f700e4f0bb80b0 100755 (executable)
@@ -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
 {
index e3c2ed9e2469dd70cfcec7ae5f57a603520481dd..706e770db59c5f937542f6fead683b3efff8b0b7 100644 (file)
@@ -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
 {
index f9db7e535c3ca6bf2a3ecef18b4ac4d39a73a84a..71e934aca7d3bc4ba723cd4175715cf165c65137 100644 (file)
@@ -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
 {
index ce01edd8078b0a25f2c27c7e48b989c924cd67e2..16862065f46ac79707f536d479eb6449c9d4eb88 100644 (file)
@@ -11,6 +11,7 @@
 
 /** \class FeaturesPlugin_RevolutionBoolean
  *  \ingroup Plugins
+ *  \brief Interface for the composite revolution feature.
  */
 class FeaturesPlugin_RevolutionBoolean : public FeaturesPlugin_CompositeBoolean
 {
index f5a79a11a6fc32556aa2bd970071d7862f871aae..3c1340262ba1a953287a3c004394cbad385cccef 100644 (file)
@@ -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
 {
index cf957781b7fb40e11913503c55b7d6027cfc5317..75f16aa67e1818136e47659aad86e9dcdaf0aea7 100644 (file)
@@ -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
 {
index b211c9222d258e26319bb948b7f8b2ecccf0b14a..fe914cc5db0a88cc55a9551c641ec179ad0653f8 100644 (file)
@@ -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
 {
index b1bb5c256347d3c08121aa412c24806298c457ba..b957253e33c28bdd2766f7aea3f4ddcb679307ff 100755 (executable)
@@ -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<std::string>& theArguments,
                        std::string& theError) const;
index 3791071dd0e35890be5ba40bfa916de0294b32cc..32cac89686e2ee8ebb7e5a0b2054cf773c4bb3fd 100644 (file)
@@ -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<GeomAPI_Pnt> thePoint,
                                       const double theTolerance,
index de9c6d299f5dbb359aee66febcb07473c2003c73..2c2520ba9508f42935358c4ff69e55165113b3e8 100644 (file)
 #include "GeomAPI_AISObject.h"
 
 #include <vector>
-/**
-* 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:
index c26ad2505e180e386ff739d3852b85012581ab52..9ba13cd1a0be499dfa5d8f9621ff9c61a0b37002 100644 (file)
@@ -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<GeomAPI_Pnt>& theOrigin,
                                const std::shared_ptr<GeomAPI_Dir>& theDirX,
index 29136a0cb8e21513869d5342e4e84665c25dadeb..44320fa641f122c653fab52a3a437c791394e4cc 100644 (file)
@@ -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<GeomAPI_Shape>& 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<GeomAPI_Shape>& theShape,
index 1c3655d9b0fdcbbc13c4854d88064109da3079b9..86e6dc9b80d7625354e6218af25289a0a6d2ebea 100644 (file)
 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:
index a4c19e8c2961dd4403f2551b6112206a14277586..b4e46e54a15d7e1c1fbc3263086ebcfcff148625 100644 (file)
@@ -53,10 +53,10 @@ protected:
   GEOMALGOAPI_EXPORT GeomAlgoAPI_MakeShape(){};
 
 protected:
-  GeomAlgoAPI_MakeShape::AlgoType myAlgoType;
-  std::shared_ptr<GeomAPI_Shape> myShape;
-  std::shared_ptr<GeomAPI_Shape> myWire;
-  std::shared_ptr<GeomAPI_Shape> myBaseShape;
+  GeomAlgoAPI_MakeShape::AlgoType myAlgoType; ///< Type of make shape algo.
+  std::shared_ptr<GeomAPI_Shape> myShape; ///< Resulting shape.
+  std::shared_ptr<GeomAPI_Shape> myWire; ///< Wire for pipe algo.
+  std::shared_ptr<GeomAPI_Shape> myBaseShape; ///< Base shape of algo.
 };
 
 typedef std::list<std::shared_ptr<GeomAlgoAPI_MakeShape> > ListOfMakeShape;
index 6b6682c1cfa0fb02f79284160381e08404ecafc3..0ba480907d05af9ca60c7527dd8e274f59d3d4bf 100644 (file)
@@ -68,7 +68,7 @@ private:
 
 
 protected:
-  ListOfMakeShape myListOfMakeShape;
+  ListOfMakeShape myListOfMakeShape; ///< List of make shape algos.
 };
 
 #endif
index c3562f75abffb6d809219e79c1914b46184a713b..2484fcee19a99412529d2892760c7a1be107f506 100644 (file)
@@ -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.
index fa792b2d66f0d79b3ab80e21c42b153e05f51ed2..c367d6867846bb36da2de8b2565c61a104e66e3d 100644 (file)
@@ -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<GeomAPI_Shape> theCompound,
                             const GeomAPI_Shape::ShapeType theType,
index a4da606b137a52c7dbdd99e3df8af420d288efa4..f442df89d27bece92f75b516b1e61d5b2a62cc34 100644 (file)
@@ -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
index fa950240e7d860c02ee59c790963706c5e46bd83..7877f702896389920cdd79aefa80764d1da16b16 100644 (file)
 
 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:
   /**
index e6897060a084b0602e41db2d62e16bdb035dc10d..91c7dcad93e49b562fd3ea541db74ede2baf70b2 100644 (file)
@@ -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<ModelAPI_Feature>& theFeature,
                                              const std::list<std::string>& theArguments,