OpenCascade/occt
1
0
Fork 0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-08 18:40:55 +03:00
Code Packages Releases Activity

0026273: Comments to methods are misplaced in gp_Vec.cdl

Browse Source 
Location of comments corrected

Grammar fix
This commit is contained in:
abv 2015-06-19 11:45:29 +03:00 committed by bugmaster
parent 93937391be
commit f809e94b93
2 changed files with 31 additions and 41 deletions

47
src/gp/gp_Vec.cdl

@ -175,7 +175,7 @@ is
AngleWithRef (me; Other , VRef : Vec) returns Real AngleWithRef (me; Other , VRef : Vec) returns Real
---C++: inline ---C++: inline
--- Purpose : Computes the angle, in radians, between this vector and ---Purpose : Computes the angle, in radians, between this vector and
-- vector Other. The result is a value between -Pi and Pi. -- vector Other. The result is a value between -Pi and Pi.
-- For this, VRef defines the positive sense of rotation: the -- For this, VRef defines the positive sense of rotation: the
-- angular value is positive, if the cross product this ^ Other -- angular value is positive, if the cross product this ^ Other
@ -204,52 +204,50 @@ is
---Purpose: Computes the square magnitude of this vector. ---Purpose: Computes the square magnitude of this vector.
---C++: inline ---C++: inline
--- Purpose : Adds two vectors
Add (me : in out; Other : Vec) is static; Add (me : in out; Other : Vec) is static;
---C++: inline ---C++: inline
---C++: alias operator += ---C++: alias operator +=
--- Purpose : Adds two vectors
Added (me; Other : Vec) returns Vec is static; Added (me; Other : Vec) returns Vec is static;
---C++: inline ---C++: inline
---C++: alias operator + ---C++: alias operator +
--- Purpose : Adds two vectors --- Purpose : Adds two vectors
--- Purpose : Subtracts two vectors
Subtract (me : in out; Right : Vec) is static; Subtract (me : in out; Right : Vec) is static;
---C++: inline ---C++: inline
---C++: alias operator -= ---C++: alias operator -=
--- Purpose : Subtracts two vectors
Subtracted (me; Right : Vec) returns Vec is static; Subtracted (me; Right : Vec) returns Vec is static;
---C++: inline ---C++: inline
---C++: alias operator - ---C++: alias operator -
--- Purpose : Subtracts two vectors --- Purpose : Subtracts two vectors
--- Purpose : Multiplies a vector by a scalar
Multiply (me : in out; Scalar : Real) is static; Multiply (me : in out; Scalar : Real) is static;
---C++: inline ---C++: inline
---C++: alias operator *= ---C++: alias operator *=
--- Purpose : Multiplies a vector by a scalar
Multiplied (me; Scalar : Real) returns Vec is static; Multiplied (me; Scalar : Real) returns Vec is static;
---C++: inline ---C++: inline
---C++: alias operator * ---C++: alias operator *
--- Purpose : Multiplies a vector by a scalar --- Purpose : Multiplies a vector by a scalar
--- Purpose : Divides a vector by a scalar
Divide (me : in out; Scalar : Real) is static; Divide (me : in out; Scalar : Real) is static;
---C++: inline ---C++: inline
---C++: alias operator /= ---C++: alias operator /=
--- Purpose : Divides a vector by a scalar
Divided (me; Scalar : Real) returns Vec is static; Divided (me; Scalar : Real) returns Vec is static;
---C++: inline ---C++: inline
---C++: alias operator / ---C++: alias operator /
--- Purpose : Divides a vector by a scalar --- Purpose : Divides a vector by a scalar
--- Purpose : computes the cross product between two vectors
Cross (me : in out; Right : Vec) is static; Cross (me : in out; Right : Vec) is static;
---C++: inline ---C++: inline
---C++: alias operator ^= ---C++: alias operator ^=
--- Purpose : computes the cross product between two vectors
Crossed (me; Right : Vec) returns Vec is static; Crossed (me; Right : Vec) returns Vec is static;
--- Purpose : computes the cross product between two vectors --- Purpose : computes the cross product between two vectors
@ -270,15 +268,13 @@ is
-- Returns || <me> ^ Right ||**2 -- Returns || <me> ^ Right ||**2
---C++: inline ---C++: inline
--- Purpose : Computes the triple vector product.
-- <me> ^ (V1 ^ V2)
CrossCross (me : in out; V1, V2 : Vec) is static; CrossCross (me : in out; V1, V2 : Vec) is static;
---C++: inline ---C++: inline
--- Purpose : Computes the triple vector product.
-- <me> ^= (V1 ^ V2)
CrossCrossed (me; V1, V2 : Vec) returns Vec is static; CrossCrossed (me; V1, V2 : Vec) returns Vec is static;
---C++: inline ---C++: inline
--- Purpose : Computes the triple vector product. --- Purpose : Computes the triple vector product.
-- <me> ^ (V1 ^ V2) -- <me> ^ (V1 ^ V2)
@ -291,24 +287,21 @@ is
---C++: inline ---C++: inline
--- Purpose : Computes the triple scalar product <me> * (V1 ^ V2). --- Purpose : Computes the triple scalar product <me> * (V1 ^ V2).
Normalize (me : in out) raises ConstructionError is static;
---C++: inline
--- Purpose : normalizes a vector --- Purpose : normalizes a vector
-- Raises an exception if the magnitude of the vector is -- Raises an exception if the magnitude of the vector is
-- lower or equal to Resolution from gp. -- lower or equal to Resolution from gp.
Normalize (me : in out) raises ConstructionError is static;
---C++: inline
Normalized (me) returns Vec raises ConstructionError is static; Normalized (me) returns Vec raises ConstructionError is static;
--- Purpose : normalizes a vector --- Purpose : normalizes a vector
-- Raises an exception if the magnitude of the vector is -- Raises an exception if the magnitude of the vector is
-- lower or equal to Resolution from gp. -- lower or equal to Resolution from gp.
---C++: inline ---C++: inline
--- Purpose : Reverses the direction of a vector
Reverse (me : in out) is static; Reverse (me : in out) is static;
---C++: inline ---C++: inline
--- Purpose : Reverses the direction of a vector
Reversed (me) returns Vec is static; Reversed (me) returns Vec is static;
--- Purpose : Reverses the direction of a vector --- Purpose : Reverses the direction of a vector
@ -320,7 +313,7 @@ is
A3 : Real; V3 : Vec; V4 : Vec) A3 : Real; V3 : Vec; V4 : Vec)
is static; is static;
--- Purpose : --- Purpose :
-- <me> is setted to the following linear form : -- <me> is set to the following linear form :
-- A1 * V1 + A2 * V2 + A3 * V3 + V4 -- A1 * V1 + A2 * V2 + A3 * V3 + V4
---C++: inline ---C++: inline
@ -328,7 +321,7 @@ is
A1 : Real; V1 : Vec; A2 : Real; V2 : Vec; A3 : Real; V3 : Vec) A1 : Real; V1 : Vec; A2 : Real; V2 : Vec; A3 : Real; V3 : Vec)
is static; is static;
--- Purpose : --- Purpose :
-- <me> is setted to the following linear form : -- <me> is set to the following linear form :
-- A1 * V1 + A2 * V2 + A3 * V3 -- A1 * V1 + A2 * V2 + A3 * V3
---C++: inline ---C++: inline
@ -336,27 +329,27 @@ is
A1 : Real; V1 : Vec; A2 : Real; V2 : Vec; V3 : Vec) A1 : Real; V1 : Vec; A2 : Real; V2 : Vec; V3 : Vec)
is static; is static;
--- Purpose : --- Purpose :
-- <me> is setted to the following linear form : -- <me> is set to the following linear form :
-- A1 * V1 + A2 * V2 + V3 -- A1 * V1 + A2 * V2 + V3
---C++: inline ---C++: inline
SetLinearForm (me : in out; A1 : Real; V1 : Vec; A2 : Real; V2 : Vec) SetLinearForm (me : in out; A1 : Real; V1 : Vec; A2 : Real; V2 : Vec)
is static; is static;
--- Purpose : --- Purpose :
-- <me> is setted to the following linear form : -- <me> is set to the following linear form :
-- A1 * V1 + A2 * V2 -- A1 * V1 + A2 * V2
---C++: inline ---C++: inline
SetLinearForm (me : in out; A1 : Real; V1, V2 : Vec) SetLinearForm (me : in out; A1 : Real; V1, V2 : Vec)
is static; is static;
--- Purpose : --- Purpose :
-- <me> is setted to the following linear form : A1 * V1 + V2 -- <me> is set to the following linear form : A1 * V1 + V2
---C++: inline ---C++: inline
SetLinearForm (me : in out; V1, V2 : Vec) SetLinearForm (me : in out; V1, V2 : Vec)
is static; is static;
--- Purpose : --- Purpose :
-- <me> is setted to the following linear form : V1 + V2 -- <me> is set to the following linear form : V1 + V2
---C++: inline ---C++: inline
Mirror (me : in out; V : Vec) is static; Mirror (me : in out; V : Vec) is static;
@ -399,9 +392,9 @@ is
Scaled (me; S : Real) returns Vec is static; Scaled (me; S : Real) returns Vec is static;
--- Purpose : Scales a vector. S is the scaling value. --- Purpose : Scales a vector. S is the scaling value.
---C++: inline ---C++: inline
--- Purpose : Transforms a vector with the transformation T.
Transform (me : in out; T : Trsf) is static; Transform (me : in out; T : Trsf) is static;
--- Purpose : Transforms a vector with the transformation T.
Transformed (me; T : Trsf) returns Vec is static; Transformed (me; T : Trsf) returns Vec is static;
---C++: inline ---C++: inline

25
src/gp/gp_Vec2d.cdl

@ -43,7 +43,7 @@ is
Create (Xv, Yv : Real) returns Vec2d; Create (Xv, Yv : Real) returns Vec2d;
---C++: inline ---C++: inline
--- Purpose : Creates a point with its two cartesian coordinates. --- Purpose : Creates a point with its two Cartesian coordinates.
Create (P1, P2 : Pnt2d) returns Vec2d; Create (P1, P2 : Pnt2d) returns Vec2d;
---C++: inline ---C++: inline
@ -242,11 +242,10 @@ is
---C++: alias operator - ---C++: alias operator -
--- Purpose : Reverses the direction of a vector --- Purpose : Reverses the direction of a vector
--- Purpose : Subtracts two vectors
Subtract (me : in out; Right : Vec2d) is static; Subtract (me : in out; Right : Vec2d) is static;
---C++: inline ---C++: inline
---C++: alias operator -= ---C++: alias operator -=
--- Purpose : Subtracts two vectors
Subtracted (me; Right : Vec2d) returns Vec2d is static; Subtracted (me; Right : Vec2d) returns Vec2d is static;
---C++: inline ---C++: inline
@ -257,49 +256,47 @@ is
A1 : Real; V1 : Vec2d; A2 : Real; V2 : Vec2d; V3 : Vec2d) A1 : Real; V1 : Vec2d; A2 : Real; V2 : Vec2d; V3 : Vec2d)
is static; is static;
--- Purpose : --- Purpose :
-- <me> is setted to the following linear form : -- <me> is set to the following linear form :
-- A1 * V1 + A2 * V2 + V3 -- A1 * V1 + A2 * V2 + V3
---C++: inline ---C++: inline
SetLinearForm (me : in out; A1 : Real; V1 : Vec2d; A2 : Real; V2 : Vec2d) SetLinearForm (me : in out; A1 : Real; V1 : Vec2d; A2 : Real; V2 : Vec2d)
is static; is static;
--- Purpose : --- Purpose :
-- <me> is setted to the following linear form : A1 * V1 + A2 * V2 -- <me> is set to the following linear form : A1 * V1 + A2 * V2
---C++: inline ---C++: inline
SetLinearForm (me : in out; A1 : Real; V1, V2 : Vec2d) is static; SetLinearForm (me : in out; A1 : Real; V1, V2 : Vec2d) is static;
--- Purpose : --- Purpose :
-- <me> is setted to the following linear form : A1 * V1 + V2 -- <me> is set to the following linear form : A1 * V1 + V2
---C++: inline ---C++: inline
SetLinearForm (me : in out; Left, Right : Vec2d) is static; SetLinearForm (me : in out; Left, Right : Vec2d) is static;
--- Purpose : --- Purpose :
-- <me> is setted to the following linear form : Left + Right -- <me> is set to the following linear form : Left + Right
---C++: inline ---C++: inline
Mirror (me : in out; V : Vec2d) is static;
--- Purpose : --- Purpose :
-- Performs the symmetrical transformation of a vector -- Performs the symmetrical transformation of a vector
-- with respect to the vector V which is the center of -- with respect to the vector V which is the center of
-- the symmetry. -- the symmetry.
Mirror (me : in out; V : Vec2d) is static;
Mirrored (me; V : Vec2d) returns Vec2d is static; Mirrored (me; V : Vec2d) returns Vec2d is static;
--- Purpose : --- Purpose :
-- Performs the symmetrical transformation of a vector -- Performs the symmetrical transformation of a vector
-- with respect to the vector V which is the center of -- with respect to the vector V which is the center of
-- the symmetry. -- the symmetry.
--- Purpose :
Mirror (me : in out; A1 : Ax2d) is static;
---Purpose :
-- Performs the symmetrical transformation of a vector -- Performs the symmetrical transformation of a vector
-- with respect to an axis placement which is the axis -- with respect to an axis placement which is the axis
-- of the symmetry. -- of the symmetry.
Mirror (me : in out; A1 : Ax2d) is static;
Mirrored (me; A1 : Ax2d) returns Vec2d is static; Mirrored (me; A1 : Ax2d) returns Vec2d is static;
--- Purpose : ---Purpose :
-- Performs the symmetrical transformation of a vector -- Performs the symmetrical transformation of a vector
-- with respect to an axis placement which is the axis -- with respect to an axis placement which is the axis
-- of the symmetry. -- of the symmetry.