lili/OCCT
1
0
Fork 0
mirror of https://github.com/Open-Cascade-SAS/OCCT.git synced 2026-07-05 06:56:50 +08:00
Code Issues Packages Projects Releases Wiki Activity

Documentation - Update parameter annotations for consistency #161

Browse Source 
Reorganized style for param to the next templates:
 - "@param theParameter description ..."
 - "@param[in] theParameter description ..."
 - "@param[out] theParameter description ..."
 - "@param[in][out] theParameter description ..."
 The replacement was with keeping spacing, no removing of extra spaces.
In some files '/' was used instead of '@', that was not updated yet.
This commit is contained in:
dpasukhi
2024-11-17 20:22:51 +00:00
parent ac5a612645
commit 604c3b890c
213 changed files with 2258 additions and 2258 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
src/BRepPrimAPI/BRepPrimAPI_MakeCone.hxx
View File

@@ -39,23 +39,23 @@ public:
//! Make a cone.
//! @param R1 [in] cone bottom radius, may be null (z = 0)
//! @param R2 [in] cone top radius, may be null (z = H)
//! @param H [in] cone height
//! @param[in] R1 cone bottom radius, may be null (z = 0)
//! @param[in] R2 cone top radius, may be null (z = H)
//! @param[in] H cone height
Standard_EXPORT BRepPrimAPI_MakeCone(const Standard_Real R1, const Standard_Real R2, const Standard_Real H);
//! Make a cone.
//! @param R1 [in] cone bottom radius, may be null (z = 0)
//! @param R2 [in] cone top radius, may be null (z = H)
//! @param H [in] cone height
//! @param angle [in] angle to create a part cone
//! @param[in] R1 cone bottom radius, may be null (z = 0)
//! @param[in] R2 cone top radius, may be null (z = H)
//! @param[in] H cone height
//! @param[in] angle angle to create a part cone
Standard_EXPORT BRepPrimAPI_MakeCone(const Standard_Real R1, const Standard_Real R2, const Standard_Real H, const Standard_Real angle);
//! Make a cone.
//! @param axes [in] coordinate system for the construction of the cone
//! @param R1 [in] cone bottom radius, may be null (z = 0)
//! @param R2 [in] cone top radius, may be null (z = H)
//! @param H [in] cone height
//! @param[in] axes coordinate system for the construction of the cone
//! @param[in] R1 cone bottom radius, may be null (z = 0)
//! @param[in] R2 cone top radius, may be null (z = H)
//! @param[in] H cone height
Standard_EXPORT BRepPrimAPI_MakeCone(const gp_Ax2& Axes, const Standard_Real R1, const Standard_Real R2, const Standard_Real H);
//! Make a cone of height H radius R1 in the plane z =

16
src/BRepPrimAPI/BRepPrimAPI_MakeCylinder.hxx
View File

@@ -38,20 +38,20 @@ public:
DEFINE_STANDARD_ALLOC
//! Make a cylinder.
//! @param R [in] cylinder radius
//! @param H [in] cylinder height
//! @param[in] R cylinder radius
//! @param[in] H cylinder height
Standard_EXPORT BRepPrimAPI_MakeCylinder(const Standard_Real R, const Standard_Real H);
//! Make a cylinder (part cylinder).
//! @param R [in] cylinder radius
//! @param H [in] cylinder height
//! @param Angle [in] defines the missing portion of the cylinder
//! @param[in] R cylinder radius
//! @param[in] H cylinder height
//! @param[in] Angle defines the missing portion of the cylinder
Standard_EXPORT BRepPrimAPI_MakeCylinder(const Standard_Real R, const Standard_Real H, const Standard_Real Angle);
//! Make a cylinder of radius R and length H.
//! @param Axes [in] coordinate system for the construction of the cylinder
//! @param R [in] cylinder radius
//! @param H [in] cylinder height
//! @param[in] Axes coordinate system for the construction of the cylinder
//! @param[in] R cylinder radius
//! @param[in] H cylinder height
Standard_EXPORT BRepPrimAPI_MakeCylinder(const gp_Ax2& Axes, const Standard_Real R, const Standard_Real H);
//! Make a cylinder of radius R and length H with

66
src/BRepPrimAPI/BRepPrimAPI_MakeSphere.hxx
View File

@@ -39,69 +39,69 @@ public:
//! Make a sphere.
//! @param R [in] sphere radius
//! @param[in] R sphere radius
Standard_EXPORT BRepPrimAPI_MakeSphere(const Standard_Real R);
//! Make a sphere (spherical wedge).
//! @param R [in] sphere radius
//! @param angle [in] angle between the radii lying within the bounding semidisks
//! @param[in] R sphere radius
//! @param[in] angle angle between the radii lying within the bounding semidisks
Standard_EXPORT BRepPrimAPI_MakeSphere(const Standard_Real R, const Standard_Real angle);
//! Make a sphere (spherical segment).
//! @param R [in] sphere radius
//! @param angle1 [in] first angle defining a spherical segment
//! @param angle2 [in] second angle defining a spherical segment
//! @param[in] R sphere radius
//! @param[in] angle1 first angle defining a spherical segment
//! @param[in] angle2 second angle defining a spherical segment
Standard_EXPORT BRepPrimAPI_MakeSphere(const Standard_Real R, const Standard_Real angle1, const Standard_Real angle2);
//! Make a sphere (spherical segment).
//! @param R [in] sphere radius
//! @param angle1 [in] first angle defining a spherical segment
//! @param angle2 [in] second angle defining a spherical segment
//! @param angle3 [in] angle between the radii lying within the bounding semidisks
//! @param[in] R sphere radius
//! @param[in] angle1 first angle defining a spherical segment
//! @param[in] angle2 second angle defining a spherical segment
//! @param[in] angle3 angle between the radii lying within the bounding semidisks
Standard_EXPORT BRepPrimAPI_MakeSphere(const Standard_Real R, const Standard_Real angle1, const Standard_Real angle2, const Standard_Real angle3);
//! Make a sphere.
//! @param Center [in] sphere center coordinates
//! @param R [in] sphere radius
//! @param[in] Center sphere center coordinates
//! @param[in] R sphere radius
Standard_EXPORT BRepPrimAPI_MakeSphere(const gp_Pnt& Center, const Standard_Real R);
//! Make a sphere (spherical wedge).
//! @param Center [in] sphere center coordinates
//! @param R [in] sphere radius
//! @param angle [in] angle between the radii lying within the bounding semidisks
//! @param[in] Center sphere center coordinates
//! @param[in] R sphere radius
//! @param[in] angle angle between the radii lying within the bounding semidisks
Standard_EXPORT BRepPrimAPI_MakeSphere(const gp_Pnt& Center, const Standard_Real R, const Standard_Real angle);
//! Make a sphere (spherical segment).
//! @param Center [in] sphere center coordinates
//! @param R [in] sphere radius
//! @param angle1 [in] first angle defining a spherical segment
//! @param angle2 [in] second angle defining a spherical segment
//! @param[in] Center sphere center coordinates
//! @param[in] R sphere radius
//! @param[in] angle1 first angle defining a spherical segment
//! @param[in] angle2 second angle defining a spherical segment
Standard_EXPORT BRepPrimAPI_MakeSphere(const gp_Pnt& Center, const Standard_Real R, const Standard_Real angle1, const Standard_Real angle2);
//! Make a sphere (spherical segment).
//! @param Center [in] sphere center coordinates
//! @param R [in] sphere radius
//! @param angle1 [in] first angle defining a spherical segment
//! @param angle2 [in] second angle defining a spherical segment
//! @param angle3 [in] angle between the radii lying within the bounding semidisks
//! @param[in] Center sphere center coordinates
//! @param[in] R sphere radius
//! @param[in] angle1 first angle defining a spherical segment
//! @param[in] angle2 second angle defining a spherical segment
//! @param[in] angle3 angle between the radii lying within the bounding semidisks
Standard_EXPORT BRepPrimAPI_MakeSphere(const gp_Pnt& Center, const Standard_Real R, const Standard_Real angle1, const Standard_Real angle2, const Standard_Real angle3);
//! Make a sphere.
//! @param Axis [in] coordinate system for the construction of the sphere
//! @param R [in] sphere radius
//! @param[in] Axis coordinate system for the construction of the sphere
//! @param[in] R sphere radius
Standard_EXPORT BRepPrimAPI_MakeSphere(const gp_Ax2& Axis, const Standard_Real R);
//! Make a sphere (spherical wedge).
//! @param Axis [in] coordinate system for the construction of the sphere
//! @param R [in] sphere radius
//! @param angle [in] angle between the radii lying within the bounding semidisks
//! @param[in] Axis coordinate system for the construction of the sphere
//! @param[in] R sphere radius
//! @param[in] angle angle between the radii lying within the bounding semidisks
Standard_EXPORT BRepPrimAPI_MakeSphere(const gp_Ax2& Axis, const Standard_Real R, const Standard_Real angle);
//! Make a sphere (spherical segment).
//! @param Axis [in] coordinate system for the construction of the sphere
//! @param R [in] sphere radius
//! @param angle1 [in] first angle defining a spherical segment
//! @param angle2 [in] second angle defining a spherical segment
//! @param[in] Axis coordinate system for the construction of the sphere
//! @param[in] R sphere radius
//! @param[in] angle1 first angle defining a spherical segment
//! @param[in] angle2 second angle defining a spherical segment
Standard_EXPORT BRepPrimAPI_MakeSphere(const gp_Ax2& Axis, const Standard_Real R, const Standard_Real angle1, const Standard_Real angle2);
//! Make a sphere of radius R.

52
src/BRepPrimAPI/BRepPrimAPI_MakeTorus.hxx
View File

@@ -39,50 +39,50 @@ public:
//! Make a torus.
//! @param R1 [in] distance from the center of the pipe to the center of the torus
//! @param R2 [in] radius of the pipe
//! @param[in] R1 distance from the center of the pipe to the center of the torus
//! @param[in] R2 radius of the pipe
Standard_EXPORT BRepPrimAPI_MakeTorus(const Standard_Real R1, const Standard_Real R2);
//! Make a section of a torus.
//! @param R1 [in] distance from the center of the pipe to the center of the torus
//! @param R2 [in] radius of the pipe
//! @param angle [in] angle to create a torus pipe segment
//! @param[in] R1 distance from the center of the pipe to the center of the torus
//! @param[in] R2 radius of the pipe
//! @param[in] angle angle to create a torus pipe segment
Standard_EXPORT BRepPrimAPI_MakeTorus(const Standard_Real R1, const Standard_Real R2, const Standard_Real angle);
//! Make a torus with angles on the small circle.
//! @param R1 [in] distance from the center of the pipe to the center of the torus
//! @param R2 [in] radius of the pipe
//! @param angle1 [in] first angle to create a torus ring segment
//! @param angle2 [in] second angle to create a torus ring segment
//! @param[in] R1 distance from the center of the pipe to the center of the torus
//! @param[in] R2 radius of the pipe
//! @param[in] angle1 first angle to create a torus ring segment
//! @param[in] angle2 second angle to create a torus ring segment
Standard_EXPORT BRepPrimAPI_MakeTorus(const Standard_Real R1, const Standard_Real R2, const Standard_Real angle1, const Standard_Real angle2);
//! Make a torus with angles on the small circle.
//! @param R1 [in] distance from the center of the pipe to the center of the torus
//! @param R2 [in] radius of the pipe
//! @param angle1 [in] first angle to create a torus ring segment
//! @param angle2 [in] second angle to create a torus ring segment
//! @param angle [in] angle to create a torus pipe segment
//! @param[in] R1 distance from the center of the pipe to the center of the torus
//! @param[in] R2 radius of the pipe
//! @param[in] angle1 first angle to create a torus ring segment
//! @param[in] angle2 second angle to create a torus ring segment
//! @param[in] angle angle to create a torus pipe segment
Standard_EXPORT BRepPrimAPI_MakeTorus(const Standard_Real R1, const Standard_Real R2, const Standard_Real angle1, const Standard_Real angle2, const Standard_Real angle);
//! Make a torus.
//! @param Axes [in] coordinate system for the construction of the sphere
//! @param R1 [in] distance from the center of the pipe to the center of the torus
//! @param R2 [in] radius of the pipe
//! @param[in] Axes coordinate system for the construction of the sphere
//! @param[in] R1 distance from the center of the pipe to the center of the torus
//! @param[in] R2 radius of the pipe
Standard_EXPORT BRepPrimAPI_MakeTorus(const gp_Ax2& Axes, const Standard_Real R1, const Standard_Real R2);
//! Make a section of a torus.
//! @param Axes [in] coordinate system for the construction of the sphere
//! @param R1 [in] distance from the center of the pipe to the center of the torus
//! @param R2 [in] radius of the pipe
//! @param angle [in] angle to create a torus pipe segment
//! @param[in] Axes coordinate system for the construction of the sphere
//! @param[in] R1 distance from the center of the pipe to the center of the torus
//! @param[in] R2 radius of the pipe
//! @param[in] angle angle to create a torus pipe segment
Standard_EXPORT BRepPrimAPI_MakeTorus(const gp_Ax2& Axes, const Standard_Real R1, const Standard_Real R2, const Standard_Real angle);
//! Make a torus.
//! @param Axes [in] coordinate system for the construction of the sphere
//! @param R1 [in] distance from the center of the pipe to the center of the torus
//! @param R2 [in] radius of the pipe
//! @param angle1 [in] first angle to create a torus ring segment
//! @param angle2 [in] second angle to create a torus ring segment
//! @param[in] Axes coordinate system for the construction of the sphere
//! @param[in] R1 distance from the center of the pipe to the center of the torus
//! @param[in] R2 radius of the pipe
//! @param[in] angle1 first angle to create a torus ring segment
//! @param[in] angle2 second angle to create a torus ring segment
Standard_EXPORT BRepPrimAPI_MakeTorus(const gp_Ax2& Axes, const Standard_Real R1, const Standard_Real R2, const Standard_Real angle1, const Standard_Real angle2);
//! Make a section of a torus of radii R1 R2.