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

0024784: Move documentation in CDL files to proper location

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

View File

@@ -49,10 +49,7 @@ is
--
class TFace;
---Purpose: The TFace class is inherited from the TFace from
-- TopoDS. It contains a surface, a tolerance and a
-- natural restriction flag.
--
-- Edge
--
@@ -83,92 +80,54 @@ is
--
deferred class CurveRepresentation;
---Purpose: Root for curve representations. Contains a
-- location.
class ListOfCurveRepresentation instantiates
List from TCollection (CurveRepresentation from BRep);
deferred class GCurve;
---Purpose: Root class for geometric curves representations.
-- Contains a first an a last parameter.
class Curve3D;
---Purpose: Representation by a 3d curve.
class CurveOnSurface;
---Purpose: Representation by a curve in the parametric space
-- of a surface.
class CurveOnClosedSurface;
---Purpose: Representation by two curves in the parametric
-- space of a closed surface.
class Polygon3D;
---Purpose: Representation by a 3D polygon.
class PolygonOnTriangulation;
---Purpose: Representation by an array of indices on a
-- triangulation.
class PolygonOnClosedTriangulation;
---Purpose: Representation by two arrays of indices on a
-- triangulation.
class PolygonOnSurface;
---Purpose: Representation by 2d polygon in the parametric space
-- of a surface.
class PolygonOnClosedSurface;
---Purpose: Representation by two 2d polygons in the parametric
-- space of the surface.
class CurveOn2Surfaces;
---Purpose: Geometric continuity bewtween two surfaces.
class TEdge;
---Purpose: The TEdge class is inherited from the TEdge from
-- TopoDS. It contains a 3d curve and a list of
-- representations.
--
-- Vertex
--
deferred class PointRepresentation;
---Purpose: Root for point representations. Contains a
-- location.
class ListOfPointRepresentation instantiates
List from TCollection (PointRepresentation from BRep);
class PointOnCurve;
---Purpose: Representation by a parameter on a 3D curve.
deferred class PointsOnSurface;
---Purpose: Root for points on surface.
class PointOnCurveOnSurface;
---Purpose: Representation by a parameter on a curve on a
-- surface.
class PointOnSurface;
---Purpose: Representation by two parameters on a surface.
class TVertex;
---Purpose: The TVertex class is inherited from the TVertex
-- from TopoDS. It contains a 3d point and a
-- location.
class Builder;
---Purpose: The Builder from BRep is inherited from the
-- Builder3D from TopoDS. It is used to build
-- Shapes.
class Tool;
---Purpose: The Tool from BRep is used to access the geometric
-- data.
end BRep;

View File

@@ -17,6 +17,7 @@
class Builder from BRep inherits Builder from TopoDS
---Purpose: A framework providing advanced tolerance control.
-- It is used to build Shapes.
-- If tolerance control is required, you are advised to:
-- 1. build a default precision for topology, using the
-- classes provided in the BRepAPI package

View File

@@ -18,7 +18,7 @@ deferred class GCurve from BRep inherits CurveRepresentation from BRep
---Purpose: Root class for the geometric curves
-- representation. Contains a range.
-- Contains a first and a last parameter.
uses
Location from TopLoc,

View File

@@ -16,7 +16,7 @@
class PointOnCurve from BRep inherits PointRepresentation from BRep
---Purpose:
---Purpose: Representation by a parameter on a 3D curve.
uses
Curve from Geom,

View File

@@ -15,6 +15,8 @@
-- commercial license or contractual agreement.
class PointOnCurveOnSurface from BRep inherits PointsOnSurface from BRep
---Purpose: Representation by a parameter on a curve on a
-- surface.
uses

View File

@@ -15,6 +15,7 @@
-- commercial license or contractual agreement.
class PointOnSurface from BRep inherits PointsOnSurface from BRep
---Purpose: Representation by two parameters on a surface.
uses
Surface from Geom,

View File

@@ -16,7 +16,7 @@
deferred class PointsOnSurface from BRep inherits PointRepresentation from BRep
---Purpose:
---Purpose: Root for points on surface.
uses

View File

@@ -16,7 +16,7 @@
class Polygon3D from BRep inherits CurveRepresentation from BRep
---Purpose:
---Purpose: Representation by a 3D polygon.
uses
Polygon3D from Poly,

View File

@@ -19,7 +19,7 @@ class TVertex from BRep inherits TVertex from TopoDS
---Purpose: The TVertex from BRep inherits from the TVertex
-- from TopoDS. It contains the geometric data.
--
-- The TVertex contains a 3d point and a tolerance.
-- The TVertex contains a 3d point, location and a tolerance.
--
uses
Pnt from gp,