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/TreeModel/TreeModel_ItemBase.hxx
View File

@@ -155,7 +155,7 @@ public:
{ (void)theRow, (void)theColumn; (void)theValue; }
//! Returns presentation of the item to be visualized in the view
//! \thePresentations [out] container of presentation handles
//! \thePresentations[out] container of presentation handles
Standard_EXPORT virtual void Presentations (NCollection_List<Handle(Standard_Transient)>& thePresentations);
protected:

2
tools/TreeModel/TreeModel_ItemProperties.hxx
View File

@@ -115,7 +115,7 @@ public:
int theRole = Qt::DisplayRole);
//! 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
Standard_EXPORT void Presentations (NCollection_List<Handle(Standard_Transient)>& thePresentations);
//! Returns flags for the item: ItemIsEnabled | Qt::ItemIsSelectable.

4
tools/TreeModel/TreeModel_ModelBase.hxx
View File

@@ -177,7 +177,7 @@ public:
//! Returns presentations of sub items
//! \param theIndices a container of selected indices
//! \thePresentations [out] container of presentations
//! \thePresentations[out] container of presentations
Standard_EXPORT static void SubItemsPresentations (const QModelIndexList& theIndices,
NCollection_List<Handle(Standard_Transient)>& thePresentations);
@@ -198,7 +198,7 @@ protected:
//! Returns presentations of sub items. Recursive method to get presentations of all children
//! \param theItem an item to get own presentations and presentations of children
//! \thePresentations [out] container of presentations found
//! \thePresentations[out] container of presentations found
static void subItemsPresentations (const TreeModel_ItemBasePtr& theItem,
NCollection_List<Handle(Standard_Transient)>& thePresentations);

2
tools/TreeModel/TreeModel_Tools.hxx
View File

@@ -57,7 +57,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 (QTreeView* theTreeView, QMap<QString, QString>& theItems,
const QString& thePrefix = QString());