OpenCascade/occt
1
0
Fork 0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-08-09 13:22:24 +03:00
Code Activity

0024784: Move documentation in CDL files to proper location

Browse Source 
Mostly duplicated comments were removed and missing ones were moved
into dedicated class CDL files.
Some more duplicated comments were removed from CDL files.
Correction of merge
This commit is contained in:
ski
2014-05-29 16:05:47 +04:00
committed by apn
parent bdd1223f46
commit ff8178ef85
533 changed files with 1047 additions and 2921 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
src/GC/GC.cdl
View File

@@ -35,31 +35,22 @@ private deferred class Root;
---------------------------------------------------------------------------
class MakeLine;
---Purpose: Makes a Line from Geom.
class MakeCircle;
---Purpose: Makes a Circle from Geom.
class MakeHyperbola;
---Purpose: Makes an hyperbola from Geom.
class MakeEllipse;
---Purpose: Makes an ellipse from Geom.
class MakeSegment;
---Purpose: Makes a segment of Line from the 2 points <P1> and <P2>.
class MakeArcOfCircle;
---Purpose: Makes an arc of circle (TrimmedCurve from Geom).
class MakeArcOfEllipse;
---Purpose: Makes an arc of Ellipse (TrimmedCurve from Geom).
class MakeArcOfHyperbola;
---Purpose: Makes an arc of hyperbola (TrimmedCurve from Geom).
class MakeArcOfParabola;
---Purpose: Makes an arc of parabola (TrimmedCurve from Geom).
---------------------------------------------------------------------------
-- Constructions of planes from Geom.
@@ -72,33 +63,23 @@ class MakePlane;
---------------------------------------------------------------------------
class MakeCylindricalSurface;
---Purpose: Makes a cylindricalSurface <Cyl> from Geom.
class MakeConicalSurface;
---Purpose: Makes a ConicalSurface <Cone> from Geom.
class MakeTrimmedCylinder;
---Purpose: Makes a cylindricalSurface <Cyl> from Geom
class MakeTrimmedCone;
---Purpose: Makes a ConicalSurface <Cyl> from Geom
---------------------------------------------------------------------------
-- Constructions of Transformation from Geom.
---------------------------------------------------------------------------
class MakeTranslation;
---Purpose: Returns a translation transformation of vector <V>.
class MakeMirror;
---Purpose: Returns a symmetry transformation of center <P>.
class MakeRotation;
---Purpose: Returns a rotation transformation around the axis <A>
-- and of angle <Angle>.
class MakeScale;
---Purpose: Returns a scaling transformation with the center point
-- <Point> and the scaling value <Scale>.
end GC;

3
src/GC/GC_MakeScale.cdl
View File

@@ -20,7 +20,8 @@ from GC
---Purpose: This class implements an elementary construction algorithm for
-- a scaling transformation in 3D space. The result is a
-- Geom_Transformation transformation.
-- Geom_Transformation transformation (a scaling transformation with
-- the center point <Point> and the scaling value <Scale>).
-- A MakeScale object provides a framework for:
-- - defining the construction of the transformation,
-- - implementing the construction algorithm, and

18
src/GC/GC_MakeSegment.cdl
View File

@@ -16,14 +16,16 @@
class MakeSegment from GC inherits Root from GC
--- Purpose: Implements construction algorithms for a line
-- segment in 3D space. The result is a Geom_TrimmedCurve curve.
-- A MakeSegment object provides a framework for:
-- - defining the construction of the line segment,
-- - implementing the construction algorithm, and
-- - consulting the results. In particular, the Value
-- function returns the constructed line segment.
--- Purpose: Implements construction algorithms for a line
-- segment in 3D space.
-- Makes a segment of Line from the 2 points <P1> and <P2>.
-- The result is a Geom_TrimmedCurve curve.
-- A MakeSegment object provides a framework for:
-- - defining the construction of the line segment,
-- - implementing the construction algorithm, and
-- - consulting the results. In particular, the Value
-- function returns the constructed line segment.
uses Pnt from gp,
Real from Standard,
Lin from gp,

14
src/GC/GC_MakeTranslation.cdl
View File

@@ -18,13 +18,13 @@ class MakeTranslation
from GC
---Purpose: This class mplements elementary construction algorithms for a
-- translation in 3D space. The result is a
-- Geom_Transformation transformation.
-- A MakeTranslation object provides a framework for:
-- - defining the construction of the transformation,
-- - implementing the construction algorithm, and
-- - consulting the result.
---Purpose: This class implements elementary construction algorithms for a
-- translation in 3D space. The result is a
-- Geom_Transformation transformation.
-- A MakeTranslation object provides a framework for:
-- - defining the construction of the transformation,
-- - implementing the construction algorithm, and
-- - consulting the result.
uses Pnt from gp,
Transformation from Geom,