Merge branch 'Pre_2.8.0_development'

[modules/shaper.git] / src / GeomAlgoAPI / GeomAlgoAPI_Cylinder.h

diff --git a/src/GeomAlgoAPI/GeomAlgoAPI_Cylinder.h b/src/GeomAlgoAPI/GeomAlgoAPI_Cylinder.h
index b0f91e27cd128f53239ee9bd2c0de069d6b6e875..9fdf285d5b2c2a92658faf454a9e3931be24608b 100644 (file)
--- a/src/GeomAlgoAPI/GeomAlgoAPI_Cylinder.h
+++ b/src/GeomAlgoAPI/GeomAlgoAPI_Cylinder.h
@@ -1,8 +1,22 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File:        GeomAlgoAPI_Cylinder.h
-// Created:     05 Jan 2016
-// Author:      Clarisse Genrault (CEA)
+// Copyright (C) 2014-2017  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<mailto:webmaster.salome@opencascade.com>
+//
 
 #ifndef GEOMALGOAPI_CYLINDER_H_
 #define GEOMALGOAPI_CYLINDER_H_
@@ -21,16 +35,15 @@ class GeomAlgoAPI_Cylinder : public GeomAlgoAPI_MakeShape
  public:
   GEOMALGOAPI_EXPORT GeomAlgoAPI_Cylinder();
 
-  /// Creates a cylinder
+  /// Creates a cylinder.
   /// \param theAxis The axis of the cylinder
   /// \param theRadius The radius of the cylinder
   /// \param theHeight The height of the cylinder
-  /// \param theAngle The covering angle of the cylinder
   GEOMALGOAPI_EXPORT GeomAlgoAPI_Cylinder(std::shared_ptr<GeomAPI_Ax2> theAxis,
                                           const double theRadius,
                                           const double theHeight);
 
-  /// Creates a cylinder
+  /// Creates a cylinder.
   /// \param theAxis The axis of the cylinder
   /// \param theRadius The radius of the cylinder
   /// \param theHeight The height of the cylinder
@@ -47,8 +60,8 @@ class GeomAlgoAPI_Cylinder : public GeomAlgoAPI_MakeShape
   GEOMALGOAPI_EXPORT void build();
 
  private:
-  bool withAngle;
-  std::shared_ptr<GeomAPI_Pnt> myBasePoint;
+  bool withAngle; /// Boolean indicating if the type of cylinder (full or portion).
+  std::shared_ptr<GeomAPI_Pnt> myBasePoint; /// Center of the lower base of the cylinder.
   std::shared_ptr<GeomAPI_Ax2> myAxis; /// Axis of the cylinder.
   double myRadius; /// Radius of the cylinder.
   double myHeight; /// Height of the cylinder.