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

16
src/STEPCAFControl/STEPCAFControl_Provider.hxx
View File

@@ -47,7 +47,7 @@ public:
//! @param[in] thePath path to the import CAD file
//! @param[out] theDocument document to save result
//! @param[in] theWS current work session
//! @param theProgress[in] progress indicator
//! @param[in] theProgress progress indicator
//! @return true if Read operation has ended correctly
Standard_EXPORT virtual bool Read(const TCollection_AsciiString& thePath,
const Handle(TDocStd_Document)& theDocument,
@@ -58,7 +58,7 @@ public:
//! @param[in] thePath path to the export CAD file
//! @param[out] theDocument document to export
//! @param[in] theWS current work session
//! @param theProgress[in] progress indicator
//! @param[in] theProgress progress indicator
//! @return true if Write operation has ended correctly
Standard_EXPORT virtual bool Write(const TCollection_AsciiString& thePath,
const Handle(TDocStd_Document)& theDocument,
@@ -68,7 +68,7 @@ public:
//! Reads a CAD file, according internal configuration
//! @param[in] thePath path to the import CAD file
//! @param[out] theDocument document to save result
//! @param theProgress[in] progress indicator
//! @param[in] theProgress progress indicator
//! @return true if Read operation has ended correctly
Standard_EXPORT virtual bool Read(const TCollection_AsciiString& thePath,
const Handle(TDocStd_Document)& theDocument,
@@ -77,7 +77,7 @@ public:
//! Writes a CAD file, according internal configuration
//! @param[in] thePath path to the export CAD file
//! @param[out] theDocument document to export
//! @param theProgress[in] progress indicator
//! @param[in] theProgress progress indicator
//! @return true if Write operation has ended correctly
Standard_EXPORT virtual bool Write(const TCollection_AsciiString& thePath,
const Handle(TDocStd_Document)& theDocument,
@@ -87,7 +87,7 @@ public:
//! @param[in] thePath path to the import CAD file
//! @param[out] theShape shape to save result
//! @param[in] theWS current work session
//! @param theProgress[in] progress indicator
//! @param[in] theProgress progress indicator
//! @return true if Read operation has ended correctly
Standard_EXPORT virtual bool Read(const TCollection_AsciiString& thePath,
TopoDS_Shape& theShape,
@@ -98,7 +98,7 @@ public:
//! @param[in] thePath path to the export CAD file
//! @param[out] theShape shape to export
//! @param[in] theWS current work session
//! @param theProgress[in] progress indicator
//! @param[in] theProgress progress indicator
//! @return true if Write operation has ended correctly
Standard_EXPORT virtual bool Write(const TCollection_AsciiString& thePath,
const TopoDS_Shape& theShape,
@@ -108,7 +108,7 @@ public:
//! Reads a CAD file, according internal configuration
//! @param[in] thePath path to the import CAD file
//! @param[out] theShape shape to save result
//! @param theProgress[in] progress indicator
//! @param[in] theProgress progress indicator
//! @return true if Read operation has ended correctly
Standard_EXPORT virtual bool Read(const TCollection_AsciiString& thePath,
TopoDS_Shape& theShape,
@@ -117,7 +117,7 @@ public:
//! Writes a CAD file, according internal configuration
//! @param[in] thePath path to the export CAD file
//! @param[out] theShape shape to export
//! @param theProgress[in] progress indicator
//! @param[in] theProgress progress indicator
//! @return true if Write operation has ended correctly
Standard_EXPORT virtual bool Write(const TCollection_AsciiString& thePath,
const TopoDS_Shape& theShape,

10
src/STEPCAFControl/STEPCAFControl_Reader.hxx
View File

@@ -81,21 +81,21 @@ public:
//! Loads a file and returns the read status
//! Provided for use like single-file reader.
//! @param theFileName [in] file to open
//! @param[in] theFileName file to open
//! @return read status
Standard_EXPORT IFSelect_ReturnStatus ReadFile (const Standard_CString theFileName);
//! Loads a file and returns the read status
//! Provided for use like single-file reader.
//! @param theFileName [in] file to open
//! @param theParams [in] default configuration parameters
//! @param[in] theFileName file to open
//! @param[in] theParams default configuration parameters
//! @return read status
Standard_EXPORT IFSelect_ReturnStatus ReadFile(const Standard_CString theFileName,
const StepData_ConfParameters& theParams);
//! Loads a file from stream and returns the read status.
//! @param theName [in] auxiliary stream name
//! @param theIStream [in] stream to read from
//! @param[in] theName auxiliary stream name
//! @param[in] theIStream stream to read from
//! @return read status
Standard_EXPORT IFSelect_ReturnStatus ReadStream (const Standard_CString theName,
std::istream& theIStream);