OpenCascade/occt
1
0
Fork 0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-09-03 14:10:33 +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/View/View_PreviewParameters.hxx
View File

@@ -45,7 +45,7 @@ public:
//! - visibility of columns,
//! - columns width
//! \param theTreeView a view instance
//! \param theItems [out] properties
//! \param[out] theItems properties
//! \param thePrefix preference item prefix
static void SaveState (View_PreviewParameters* theParameters,
QMap<QString, QString>& theItems,

2
tools/View/View_ToolBar.hxx
View File

@@ -76,7 +76,7 @@ public:
//! Saves state of tool bar actions
//! \param theToolBar a view instance
//! \param theItems [out] properties
//! \param[out] theItems properties
//! \param thePrefix preference item prefix
Standard_EXPORT static void SaveState (View_ToolBar* theToolBar,
QMap<QString, QString>& theItems,

2
tools/View/View_Widget.hxx
View File

@@ -103,7 +103,7 @@ public:
//! Saves state of widget actions
//! \param theParameters a view instance
//! \param theItems [out] properties
//! \param[out] theItems properties
//! \param thePrefix preference item prefix
Standard_EXPORT static void SaveState (View_Widget* theWidget,
QMap<QString, QString>& theItems,

2
tools/View/View_Window.hxx
View File

@@ -80,7 +80,7 @@ public:
//! - visibility of columns,
//! - columns width
//! \param theTreeView a view instance
//! \param theItems [out] properties
//! \param[out] theItems properties
//! \param thePrefix preference item prefix
Standard_EXPORT static void SaveState (View_Window* theView, QMap<QString, QString>& theItems,
const QString& thePrefix = QString());