lili/OCCT
1
0
Fork 0
mirror of https://github.com/Open-Cascade-SAS/OCCT.git synced 2026-07-10 04:17:44 +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 =