OpenCascade/occt
1
0
Fork 0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-08-09 13:22:24 +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

6
src/Message/Message.hxx
View File

@@ -112,14 +112,14 @@ public:
}
//! Converts message metric to OSD memory info type.
//! @param theMetric [in] message metric
//! @param theMemInfo [out] filled memory info type
//! @param[in] theMetric message metric
//! @param[out] theMemInfo filled memory info type
//! @return true if converted
static Standard_EXPORT Standard_Boolean ToOSDMetric (const Message_MetricType theMetric, OSD_MemInfo::Counter& theMemInfo);
//! Converts OSD memory info type to message metric.
//! @param theMemInfo [int] memory info type
//! @param theMetric [out] filled message metric
//! @param[out] theMetric filled message metric
//! @return true if converted
static Standard_EXPORT Standard_Boolean ToMessageMetric (const OSD_MemInfo::Counter theMemInfo, Message_MetricType& theMetric);

12
src/Message/Message_AttributeMeter.hxx
View File

@@ -37,31 +37,31 @@ public:
Standard_EXPORT Message_AttributeMeter (const TCollection_AsciiString& theName = TCollection_AsciiString());
//! Checks whether the attribute has values for the metric
//! @param theMetric [in] metric type
//! @param[in] theMetric metric type
//! @return true if the metric values exist in the attribute
Standard_EXPORT Standard_Boolean HasMetric (const Message_MetricType& theMetric) const;
//! Returns true when both values of the metric are set.
//! @param theMetric [in] metric type
//! @param[in] theMetric metric type
//! @return true if metric values are valid
Standard_EXPORT Standard_Boolean IsMetricValid (const Message_MetricType& theMetric) const;
//! Returns start value for the metric
//! @param theMetric [in] metric type
//! @param[in] theMetric metric type
//! @return real value
Standard_EXPORT Standard_Real StartValue (const Message_MetricType& theMetric) const;
//! Sets start values for the metric
//! @param theMetric [in] metric type
//! @param[in] theMetric metric type
Standard_EXPORT void SetStartValue (const Message_MetricType& theMetric, const Standard_Real theValue);
//! Returns stop value for the metric
//! @param theMetric [in] metric type
//! @param[in] theMetric metric type
//! @return real value
Standard_EXPORT Standard_Real StopValue (const Message_MetricType& theMetric) const;
//! Sets stop values for the metric
//! @param theMetric [in] metric type
//! @param[in] theMetric metric type
Standard_EXPORT void SetStopValue (const Message_MetricType& theMetric, const Standard_Real theValue);
public:

10
src/Message/Message_LazyProgressScope.hxx
View File

@@ -28,11 +28,11 @@ class Message_LazyProgressScope : protected Message_ProgressScope
public:
//! Main constructor.
//! @param theRange [in] progress range to scope
//! @param theName [in] name of this scope
//! @param theMax [in] number of steps within this scope
//! @param thePatchStep [in] number of steps to update progress
//! @param theIsInf [in] infinite flag
//! @param[in] theRange progress range to scope
//! @param[in] theName name of this scope
//! @param[in] theMax number of steps within this scope
//! @param[in] thePatchStep number of steps to update progress
//! @param[in] theIsInf infinite flag
Message_LazyProgressScope (const Message_ProgressRange& theRange,
const char* theName,
const Standard_Real theMax,

24
src/Message/Message_ProgressScope.hxx
View File

@@ -217,10 +217,10 @@ public: //! @name Preparation methods
//! The topmost scope is created and owned by Message_ProgressIndicator
//! and its pointer is contained in the Message_ProgressRange returned by the Start() method of progress indicator.
//!
//! @param theRange [in][out] range to fill (will be disarmed)
//! @param theName [in] new scope name
//! @param theMax [in] number of steps in scope
//! @param isInfinite [in] infinite flag
//! @param[in][out] theRange range to fill (will be disarmed)
//! @param[in] theName new scope name
//! @param[in] theMax number of steps in scope
//! @param[in] isInfinite infinite flag
Message_ProgressScope (const Message_ProgressRange& theRange,
const TCollection_AsciiString& theName,
Standard_Real theMax,
@@ -233,10 +233,10 @@ public: //! @name Preparation methods
//! The topmost scope is created and owned by Message_ProgressIndicator
//! and its pointer is contained in the Message_ProgressRange returned by the Start() method of progress indicator.
//!
//! @param theRange [in][out] range to fill (will be disarmed)
//! @param theName [in] new scope name constant (will be stored by pointer with no deep copy)
//! @param theMax [in] number of steps in scope
//! @param isInfinite [in] infinite flag
//! @param[in][out] theRange range to fill (will be disarmed)
//! @param[in] theName new scope name constant (will be stored by pointer with no deep copy)
//! @param[in] theMax number of steps in scope
//! @param[in] isInfinite infinite flag
template<size_t N>
Message_ProgressScope (const Message_ProgressRange& theRange,
const char (&theName)[N],
@@ -250,10 +250,10 @@ public: //! @name Preparation methods
//! The topmost scope is created and owned by Message_ProgressIndicator
//! and its pointer is contained in the Message_ProgressRange returned by the Start() method of progress indicator.
//!
//! @param theRange [in][out] range to fill (will be disarmed)
//! @param theName [in] empty scope name (only NULL is accepted as argument)
//! @param theMax [in] number of steps in scope
//! @param isInfinite [in] infinite flag
//! @param[in][out] theRange range to fill (will be disarmed)
//! @param[in] theName empty scope name (only NULL is accepted as argument)
//! @param[in] theMax number of steps in scope
//! @param[in] isInfinite infinite flag
Message_ProgressScope (const Message_ProgressRange& theRange,
const NullString* theName,
Standard_Real theMax,