Fix for the issue #1045

[modules/shaper.git] / src / GeomAPI / GeomAPI_ShapeExplorer.h

diff --git a/src/GeomAPI/GeomAPI_ShapeExplorer.h b/src/GeomAPI/GeomAPI_ShapeExplorer.h
index fac506fd1589fa20393a039e1e4749fe1dcfffbe..44320fa641f122c653fab52a3a437c791394e4cc 100644 (file)
--- a/src/GeomAPI/GeomAPI_ShapeExplorer.h
+++ b/src/GeomAPI/GeomAPI_ShapeExplorer.h
@@ -14,21 +14,21 @@
  *  \ingroup DataModel
  *  \brief This class is used to explore subshapes on shape.
  */
-
 class GeomAPI_ShapeExplorer : public GeomAPI_Interface
 {
 public:
   /// Default constructor. Creates an empty explorer, becomes usefull after Init.
-  GEOMAPI_EXPORT 
+  GEOMAPI_EXPORT
   GeomAPI_ShapeExplorer();
 
   /** \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_EXPORT
   GeomAPI_ShapeExplorer(const std::shared_ptr<GeomAPI_Shape>& theShape,
                         const GeomAPI_Shape::ShapeType toFind,
                         const GeomAPI_Shape::ShapeType toAvoid = GeomAPI_Shape::SHAPE);
@@ -36,36 +36,37 @@ 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 
+  GEOMAPI_EXPORT
   void init(const std::shared_ptr<GeomAPI_Shape>& theShape,
             const GeomAPI_Shape::ShapeType toFind,
             const GeomAPI_Shape::ShapeType toAvoid = GeomAPI_Shape::SHAPE);
 
   /// \return true if there are more shapes in the exploration.
-  GEOMAPI_EXPORT 
+  GEOMAPI_EXPORT
   bool more() const;
 
   /// Moves to the next Shape in the exploration or do nothing if there are no more shapes to explore.
-  GEOMAPI_EXPORT 
+  GEOMAPI_EXPORT
   void next();
 
-  /// Returns the current shape in the exploration or empty pointer if this explorer has no more shapes to explore.
-  GEOMAPI_EXPORT 
+  /// \return the current shape in the exploration or empty pointer if this explorer has no more shapes to explore.
+  GEOMAPI_EXPORT
   std::shared_ptr<GeomAPI_Shape> current();
 
   /// Reinitialize the exploration with the original arguments.
-  GEOMAPI_EXPORT 
+  GEOMAPI_EXPORT
   void reinit();
 
-  /// Returns the current depth of the exploration. 0 is the shape to explore itself.
-  GEOMAPI_EXPORT 
+  /// \return the current depth of the exploration. 0 is the shape to explore itself.
+  GEOMAPI_EXPORT
   int depth() const;
 
   /// Clears the content of the explorer. It will return False on more().
-  GEOMAPI_EXPORT 
+  GEOMAPI_EXPORT
   void clear();
 
 };