OpenCascade/occt
1
0
Fork 0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-08-14 13:30:48 +03:00
Code 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

18
src/Select3D/Select3D_SensitiveSet.hxx
View File

@@ -115,10 +115,10 @@ protected:
Standard_Boolean theToCheckAllInside);
//! Checks whether the entity with index theIdx (partially) overlaps the current selecting volume.
//! @param thePickResult [OUT] picking result, should update minimum depth
//! @param theMgr [IN] selection manager
//! @param theElemIdx [IN] element index within BVH tree to check
//! @param theIsFullInside [IN] when TRUE indicates that entire BVH node is already inside selection volume (in case of rectangle selection);
//! @param[out] thePickResult picking result, should update minimum depth
//! @param[in] theMgr selection manager
//! @param[in] theElemIdx element index within BVH tree to check
//! @param[in] theIsFullInside when TRUE indicates that entire BVH node is already inside selection volume (in case of rectangle selection);
//! in this case algorithm might skip checking the element and just register it as detected
virtual Standard_Boolean overlapsElement (SelectBasics_PickResult& thePickResult,
SelectBasics_SelectingVolumeManager& theMgr,
@@ -126,9 +126,9 @@ protected:
Standard_Boolean theIsFullInside) = 0;
//! Checks whether the entity with index theIdx is (fully) inside the current selecting volume
//! @param theMgr [IN] selection manager
//! @param theElemIdx [IN] element index within BVH tree to check
//! @param theIsFullInside [IN] when TRUE indicates that entire BVH node is already inside selection volume (in case of rectangle selection);
//! @param[in] theMgr selection manager
//! @param[in] theElemIdx element index within BVH tree to check
//! @param[in] theIsFullInside when TRUE indicates that entire BVH node is already inside selection volume (in case of rectangle selection);
//! in this case algorithm might skip checking the element and just register it as detected
virtual Standard_Boolean elementIsInside (SelectBasics_SelectingVolumeManager& theMgr,
Standard_Integer theElemIdx,
@@ -142,8 +142,8 @@ protected:
//! @param theFirstElem index of the first element
//! @param theLastElem index of the last element
//! @param theIsFullInside when TRUE indicates that entire BVH node is already inside selection volume
//! @param thePickResult [OUT] picking result (for picking by ray)
//! @param theMatchesNb [OUT] number of processed elements
//! @param[out] thePickResult picking result (for picking by ray)
//! @param[out] theMatchesNb number of processed elements
//! @return FALSE if some element is outside the selection volume (if IsOverlapAllowed is FALSE); TRUE otherwise
Standard_EXPORT Standard_Boolean processElements (SelectBasics_SelectingVolumeManager& theMgr,
Standard_Integer theFirstElem,

6
src/Select3D/Select3D_SensitiveTriangulation.hxx
View File

@@ -52,13 +52,13 @@ public:
public:
//! Get last detected triangle.
//! @param theTriangle [out] triangle node indexes
//! @param[out] theTriangle triangle node indexes
//! @return TRUE if defined
Standard_EXPORT bool LastDetectedTriangle (Poly_Triangle& theTriangle) const;
//! Get last detected triangle.
//! @param theTriangle [out] triangle node indexes
//! @param theTriNodes [out] triangle nodes (with pre-applied transformation)
//! @param[out] theTriangle triangle node indexes
//! @param[out] theTriNodes triangle nodes (with pre-applied transformation)
//! @return TRUE if defined
Standard_EXPORT bool LastDetectedTriangle (Poly_Triangle& theTriangle,
gp_Pnt theTriNodes[3]) const;