X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FGeomAlgoAPI%2FGeomAlgoAPI_Cylinder.h;h=3eaa0067869e22fe85f04ddd556a13a65d8d9918;hb=cb0a7bdbea9f94ea30879522b230cbe773b60dc3;hp=b0f91e27cd128f53239ee9bd2c0de069d6b6e875;hpb=fbb1d8a5ead180501e98acaf19acdda4880a2050;p=modules%2Fshaper.git

diff --git a/src/GeomAlgoAPI/GeomAlgoAPI_Cylinder.h b/src/GeomAlgoAPI/GeomAlgoAPI_Cylinder.h
index b0f91e27c..3eaa00678 100644
--- a/src/GeomAlgoAPI/GeomAlgoAPI_Cylinder.h
+++ b/src/GeomAlgoAPI/GeomAlgoAPI_Cylinder.h
@@ -1,8 +1,21 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File:        GeomAlgoAPI_Cylinder.h
-// Created:     05 Jan 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_CYLINDER_H_
 #define GEOMALGOAPI_CYLINDER_H_
@@ -19,18 +32,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
@@ -40,15 +50,15 @@ class GeomAlgoAPI_Cylinder : public GeomAlgoAPI_MakeShape
                                           const double theHeight,
                                           const double theAngle);
 
-  /// Checks if data for the cyminder construction is OK.
+  /// Checks if data for the cylinder construction is OK.
   GEOMALGOAPI_EXPORT bool check();
 
   /// Builds the cylinder.
   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.