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

2
tools/MessageModel/MessageModel_ItemAlert.hxx
View File

@@ -79,7 +79,7 @@ public:
Standard_Integer& theLastPos) const Standard_OVERRIDE;
//! Returns presentation of the attribute to be visualized in the view
//! \thePresentations [out] container of presentation handles to be visualized
//! \thePresentations[out] container of presentation handles to be visualized
virtual void Presentations (NCollection_List<Handle(Standard_Transient)>& thePresentations) Standard_OVERRIDE
{ TreeModel_ItemBase::Presentations (thePresentations); thePresentations.Append (myPresentation); }

8
tools/MessageModel/MessageModel_TreeModel.hxx
View File

@@ -47,13 +47,13 @@ public:
//!< Returns columns of the model for the metric
//!< \param theMetricType metric
//!< \param theMetricColumns [out] container of metric columns
//!< \param[out] theMetricColumns container of metric columns
static Standard_EXPORT void GetMetricColumns (const Message_MetricType theMetricType, QList<int>& theMetricColumns);
//!< Returns metric type for the column
//!< \param theColumnId [in] index of the tree column
//!< \param theMetricType [out] metric type if found
//!< \param thePosition [out] index of the metric column, 0 - is metric, 1 - is delta
//!< \param[in] theColumnId index of the tree column
//!< \param[out] theMetricType metric type if found
//!< \param[out] thePosition index of the metric column, 0 - is metric, 1 - is delta
//!< \return true if the column has metric parameters
static Standard_EXPORT bool IsMetricColumn (const int theColumnId, Message_MetricType& theMetricType, int& thePosition);