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

14
src/Image/Image_DDSParser.hxx
View File

@@ -25,11 +25,11 @@ class Image_DDSParser
public:
//! Load the face from DDS file.
//! @param theSupported [in] list of supported image formats
//! @param theFile [in] file path
//! @param theFaceIndex [in] face index, within [0, Image_CompressedPixMap::NbFaces()) range;
//! @param[in] theSupported list of supported image formats
//! @param[in] theFile file path
//! @param[in] theFaceIndex face index, within [0, Image_CompressedPixMap::NbFaces()) range;
//! use -1 to skip reading the face data
//! @param theFileOffset [in] offset to the DDS data
//! @param[in] theFileOffset offset to the DDS data
//! @return loaded face or NULL if file cannot be read or not valid DDS file
Standard_EXPORT static Handle(Image_CompressedPixMap) Load (const Handle(Image_SupportedFormats)& theSupported,
const TCollection_AsciiString& theFile,
@@ -37,9 +37,9 @@ public:
const int64_t theFileOffset = 0);
//! Load the face from DDS file.
//! @param theSupported [in] list of supported image formats
//! @param theBuffer [in] pre-loaded file data, should be at least of 128 bytes long defining DDS header.
//! @param theFaceIndex [in] face index, within [0, Image_CompressedPixMap::NbFaces()) range;
//! @param[in] theSupported list of supported image formats
//! @param[in] theBuffer pre-loaded file data, should be at least of 128 bytes long defining DDS header.
//! @param[in] theFaceIndex face index, within [0, Image_CompressedPixMap::NbFaces()) range;
//! use -1 to skip reading the face data
//! @return loaded face or NULL if file cannot be read or not valid DDS file
Standard_EXPORT static Handle(Image_CompressedPixMap) Load (const Handle(Image_SupportedFormats)& theSupported,

8
src/Image/Image_VideoRecorder.hxx
View File

@@ -85,8 +85,8 @@ public:
Standard_EXPORT void Close();
//! Open output stream - initialize recorder.
//! @param theFileName [in] video filename
//! @param theParams [in] video parameters
//! @param[in] theFileName video filename
//! @param[in] theParams video parameters
Standard_EXPORT Standard_Boolean Open (const char* theFileName,
const Image_VideoParams& theParams);
@@ -109,8 +109,8 @@ protected:
Standard_EXPORT TCollection_AsciiString formatAvError (const int theError) const;
//! Append video stream.
//! theParams [in] video parameters
//! theDefCodecId [in] identifier of codec managed by FFmpeg library (AVCodecID enum)
//! theParams[in] video parameters
//! theDefCodecId[in] identifier of codec managed by FFmpeg library (AVCodecID enum)
Standard_EXPORT Standard_Boolean addVideoStream (const Image_VideoParams& theParams,
const Standard_Integer theDefCodecId);