Salome HOME
Meet coding style (split too long line)
[modules/shaper.git] / src / GeomAlgoAPI / GeomAlgoAPI_Symmetry.h
index 153f451adb91f592d99f7ad0acafb10adeba7b92..f0f33aa90bc16722d7e8fba4fbd0b77c206c523a 100644 (file)
@@ -1,8 +1,21 @@
-// Copyright (C) 2014-2016 CEA/DEN, EDF R&D
-
-// File:        GeomAlgoAPI_Symmetry.h
-// Created:     30 Nov 2016
-// Author:      Clarisse Genrault (CEA)
+// Copyright (C) 2014-2019  CEA/DEN, EDF R&D
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
 
 #ifndef GEOMALGOAPI_SYMMETRY_H_
 #define GEOMALGOAPI_SYMMETRY_H_
@@ -21,7 +34,7 @@
 class GeomAlgoAPI_Symmetry : public GeomAlgoAPI_MakeShape
 {
 public:
-  /// Type of mirror operation
+  /// Type of symmetry operation
   enum MethodType {
     BY_POINT, ///< Symmetry by point.
     BY_AXIS,  ///< Symmetry by axis.
@@ -30,29 +43,29 @@ public:
 
   /// \brief Creates an object which is obtained from current object by performing
   ///        a symmetry operation by a point.
-  /// \param[in] theSourceShape  a shape to be moved.
-  /// \param[in] thePoint        symmetry point.
+  /// \param[in] theSourceShape  the shape to be moved.
+  /// \param[in] thePoint        the symmetry point.
   GEOMALGOAPI_EXPORT GeomAlgoAPI_Symmetry(std::shared_ptr<GeomAPI_Shape> theSourceShape,
                                           std::shared_ptr<GeomAPI_Pnt>   thePoint);
 
   /// \brief Creates an object which is obtained from current object by performing
   ///        a symmetry operation by a point.
-  /// \param[in] theSourceShape  a shape to be moved.
-  /// \param[in] theAxis         symmetry axis.
+  /// \param[in] theSourceShape  the shape to be moved.
+  /// \param[in] theAxis         the symmetry axis.
   GEOMALGOAPI_EXPORT GeomAlgoAPI_Symmetry(std::shared_ptr<GeomAPI_Shape> theSourceShape,
                                           std::shared_ptr<GeomAPI_Ax1>   theAxis);
 
   /// \brief Creates an object which is obtained from current object by performing
   ///        a symmetry operation by a point.
-  /// \param[in] theSourceShape  a shape to be moved.
-  /// \param[in] thePlane        symmetry plane.
+  /// \param[in] theSourceShape  the shape to be moved.
+  /// \param[in] thePlane        the symmetry plane.
   GEOMALGOAPI_EXPORT GeomAlgoAPI_Symmetry(std::shared_ptr<GeomAPI_Shape> theSourceShape,
                                           std::shared_ptr<GeomAPI_Ax2>   thePlane);
 
-  /// Checks if data for the translation execution is OK.
+  /// Checks if data for the symmetry execution is OK.
   GEOMALGOAPI_EXPORT bool check();
 
-  /// Execute the translation.
+  /// Execute the symmetry.
   GEOMALGOAPI_EXPORT void build();
 
 private: