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

45
src/BRepBlend/BRepBlend.cdl
View File

@@ -105,74 +105,35 @@ is
class AppSurface;
---Purpose: Used to Approximate the surfaces.
deferred class AppFuncRoot;
---Purpose: Root Class Function to approximate by AppSurface
class AppFunc;
---Purpose: Function to approximate by AppSurface for
-- Surface/Surface contact.
class AppFuncRst;
---Purpose: Function to approximate by AppSurface for
-- Curve/Surface contact.
class AppFuncRstRst;
---Purpose: Function to approximate by AppSurface for
-- Curve/Curve contact.
class SurfRstEvolRad;
---Purpose: Function to approximate by AppSurface for
-- Edge/Face and evolutif radius
class SurfRstConstRad;
---Purpose: Copy of CSConstRad with pcurve on surface
-- as support.
class RstRstEvolRad;
---Purpose: Function to approximate by AppSurface for
-- Edge/Edge and evolutif radius
--
class RstRstConstRad;
---Purpose: Copy of CSConstRad with a pcurve on surface
-- as support.
class SurfPointConstRadInv;
---Purpose: Function of reframing between a point and a surface.
class SurfCurvConstRadInv;
---Purpose: Function of reframing between a restriction surface of the
-- surface and a curve.
class SurfPointEvolRadInv;
---Purpose: Fonction of reframing between a point and a surface.
class CurvPointRadInv;
---Purpose: Function of reframing between a point and a curve.
-- valid in cases of constant and progressive radius
class SurfCurvEvolRadInv;
---Purpose: Function of reframing between a surface restriction
-- of the surface and a curve.
class SurfRstLineBuilder;
---Purpose: Construction of a BRepBlend_Line between a surface and
-- a pcurve on surface from an approached
-- starting solution. The output entries of this builder
-- are of the same nature as of the traditional walking
-- but the requirements on the Line are not the same
-- If the determination of validity range is always
-- guaranteed, the criteria of correct repartition of sections
-- before smoothing are not respected. The resulting Line
-- is f(t) oriented.
class RstRstLineBuilder;
---Purpose: Construction of a BRepBlend_Line between two pcurves
-- from an approached starting solution. The output
-- entries of this builder are of the same nature
-- as of a traditional walking, but the requirements
-- to the Line are not the same. If the determination of validity range is always
-- guaranteed, the criteria of correct repartition of sections
-- before smoothing are not respected. The resulting Line
-- is f(t) oriented.
end BRepBlend;

1
src/BRepBlend/BRepBlend_AppFunc.cdl
View File

@@ -17,6 +17,7 @@
class AppFunc from BRepBlend inherits AppFuncRoot from BRepBlend
---Purpose: Function to approximate by AppSurface
-- for Surface/Surface contact.
---Level: Advanced
uses

2
src/BRepBlend/BRepBlend_AppFuncRst.cdl
View File

@@ -15,7 +15,7 @@
-- commercial license or contractual agreement.
class AppFuncRst from BRepBlend inherits AppFuncRoot from BRepBlend
---Purpose: Function to approximate by AppSurface for Edge/Face
---Purpose: Function to approximate by AppSurface for Curve/Surface contact.
---Level: Advanced
uses

2
src/BRepBlend/BRepBlend_AppFuncRstRst.cdl
View File

@@ -15,7 +15,7 @@
-- commercial license or contractual agreement.
class AppFuncRstRst from BRepBlend inherits AppFuncRoot from BRepBlend
---Purpose: Function to approximate by AppSurface for Edge/Face
---Purpose: Function to approximate by AppSurface for Edge/Face (Curve/Curve contact).
---Level: Advanced
uses

4
src/BRepBlend/BRepBlend_CurvPointRadInv.cdl
View File

@@ -18,7 +18,9 @@ class CurvPointRadInv from BRepBlend
inherits CurvPointFuncInv from Blend
---Purpose: This function is used to find a solution on a done
---Purpose: Function of reframing between a point and a curve.
-- valid in cases of constant and progressive radius.
-- This function is used to find a solution on a done
-- point of the curve 1 when using RstRstConsRad or
-- CSConstRad...
-- The vector <X> used in Value, Values and Derivatives

3
src/BRepBlend/BRepBlend_RstRstConstRad.cdl
View File

@@ -17,7 +17,8 @@
class RstRstConstRad from BRepBlend
inherits RstRstFunction from Blend
---Purpose:
---Purpose: Copy of CSConstRad with a pcurve on surface
-- as support.
uses Vector from math,
Matrix from math,

2
src/BRepBlend/BRepBlend_RstRstEvolRad.cdl
View File

@@ -17,6 +17,8 @@
class RstRstEvolRad from BRepBlend
inherits RstRstFunction from Blend
---Purpose: Function to approximate by AppSurface for
-- Edge/Edge and evolutif radius
uses Vector from math,
Matrix from math,

9
src/BRepBlend/BRepBlend_RstRstLineBuilder.cdl
View File

@@ -36,6 +36,15 @@ class RstRstLineBuilder from BRepBlend
-- 3) stall as there is a solution of problem
-- surf/surf within the domain of the surface
-- of support of the restriction.
--
-- Construction of a BRepBlend_Line between two pcurves
-- from an approached starting solution. The output
-- entries of this builder are of the same nature
-- as of a traditional walking, but the requirements
-- to the Line are not the same. If the determination of validity range is always
-- guaranteed, the criteria of correct repartition of sections
-- before smoothing are not respected. The resulting Line
-- is f(t) oriented.
uses Point from Blend,
Status from Blend,

4
src/BRepBlend/BRepBlend_SurfCurvConstRadInv.cdl
View File

@@ -18,7 +18,9 @@ class SurfCurvConstRadInv from BRepBlend
inherits SurfCurvFuncInv from Blend
---Purpose: Class used to compute a solution of the
---Purpose: Function of reframing between a restriction surface of the
-- surface and a curve.
-- Class used to compute a solution of the
-- surfRstConstRad problem on a done restriction of the
-- surface.
-- The vector <X> used in Value, Values and Derivatives

6
src/BRepBlend/BRepBlend_SurfCurvEvolRadInv.cdl
View File

@@ -18,9 +18,11 @@ class SurfCurvEvolRadInv from BRepBlend
inherits SurfCurvFuncInv from Blend
---Purpose: Class used to compute a solution of the
---Purpose: Function of reframing between a surface restriction
-- of the surface and a curve.
-- Class used to compute a solution of the
-- surfRstConstRad problem on a done restriction of the
-- surface.
-- surface.
-- The vector <X> used in Value, Values and Derivatives
-- methods has to be the vector of the parametric
-- coordinates wguide, wcurv, wrst where wguide is the

3
src/BRepBlend/BRepBlend_SurfPointConstRadInv.cdl
View File

@@ -18,7 +18,8 @@ class SurfPointConstRadInv from BRepBlend
inherits SurfPointFuncInv from Blend
---Purpose: This function is used to find a solution on a done
---Purpose: Function of reframing between a point and a surface.
-- This function is used to find a solution on a done
-- point of the curve when using SurfRstConsRad or
-- CSConstRad...
-- The vector <X> used in Value, Values and Derivatives

5
src/BRepBlend/BRepBlend_SurfPointEvolRadInv.cdl
View File

@@ -18,9 +18,10 @@ class SurfPointEvolRadInv from BRepBlend
inherits SurfPointFuncInv from Blend
---Purpose: This function is used to find a solution on a done
---Purpose: Function of reframing between a point and a surface.
-- This function is used to find a solution on a done
-- point of the curve when using SurfRstConsRad or
-- CSConstRad...
-- CSConstRad...
-- The vector <X> used in Value, Values and Derivatives
-- methods has to be the vector of the parametric
-- coordinates w, U, V where w is the parameter on the

2
src/BRepBlend/BRepBlend_SurfRstConstRad.cdl
View File

@@ -17,6 +17,8 @@
class SurfRstConstRad from BRepBlend
inherits SurfRstFunction from Blend
---Purpose: Copy of CSConstRad with pcurve on surface
-- as support.
uses Vector from math,
Matrix from math,

3
src/BRepBlend/BRepBlend_SurfRstEvolRad.cdl
View File

@@ -17,7 +17,8 @@
class SurfRstEvolRad from BRepBlend
inherits SurfRstFunction from Blend
---Purpose:
---Purpose: Function to approximate by AppSurface for
-- Edge/Face and evolutif radius
uses Vector from math,
Matrix from math,

10
src/BRepBlend/BRepBlend_SurfRstLineBuilder.cdl
View File

@@ -34,6 +34,16 @@ class SurfRstLineBuilder from BRepBlend
-- 3) stall as there is a solution to the problem
-- surf/surf within the domain of the surface
-- of support of the restriction.
--
-- Construction of a BRepBlend_Line between a surface and
-- a pcurve on surface from an approached
-- starting solution. The output entries of this builder
-- are of the same nature as of the traditional walking
-- but the requirements on the Line are not the same
-- If the determination of validity range is always
-- guaranteed, the criteria of correct repartition of sections
-- before smoothing are not respected. The resulting Line
-- is f(t) oriented.
uses Point from Blend,
Status from Blend,