chore: added docs to deploy.hpp #138
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ntlhui
requested changes
Nov 22, 2024
Comment on lines
+21
to
+23
| READ, /**< Read-only mode. */ | ||
| WRITE, /**< Write-only mode. */ | ||
| RDWR /**< Read-write mode. */ |
There was a problem hiding this comment.
Preference putting docstrings on the lines preceding the symbol
| */ | ||
| * @param pData Data to write. | ||
| * @param nBytes Number of bytes to write. | ||
| * @return int Number of bytes written. |
There was a problem hiding this comment.
@return should not name return type
| * @return int 1 if successful, otherwise 0 | ||
| * @param name Name of the session to open. | ||
| * @param state File access state (READ, WRITE, RDWR). | ||
| * @return int 1 if successful, otherwise 0. |
There was a problem hiding this comment.
@return should not name return type
| */ | ||
| * @param pData Buffer to store the read data. | ||
| * @param nBytes Number of bytes to read. | ||
| * @return int Number of bytes read. |
There was a problem hiding this comment.
@return should not name return type
| * | ||
| * @return length | ||
| */ | ||
| * @return int Length of the file in bytes. |
There was a problem hiding this comment.
@return should not name return type
| * @return int 1 if successful, otherwise 0 | ||
| */ | ||
| * @param loc Location to seek to. | ||
| * @return int 1 if successful, otherwise 0. |
There was a problem hiding this comment.
@return should not name return type
| * | ||
| * @return int 1 if successful, otherwise 0 | ||
| */ | ||
| * @return int 1 if successful, otherwise 0. |
There was a problem hiding this comment.
@return should not name return type
| * | ||
| * @return int 1 if successful, otherwise 0 | ||
| */ | ||
| * @return int 1 if successful, otherwise 0. |
There was a problem hiding this comment.
@return should not name return type
| * @return int 1 if successful, otherwise 0 | ||
| */ | ||
| * @param nBytes Number of bytes to truncate the file to. | ||
| * @return int 1 if successful, otherwise 0. |
There was a problem hiding this comment.
@return should not name return type
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.