docs: updated doc strings #101
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
Open
10 tasks
ntlhui
requested changes
Oct 18, 2024
Comment on lines
+116
to
+117
| * @details This integer represents the current position within | ||
| * the `dir_stack`. |
| * @brief Constructs a path from the current directory stack. | ||
| * | ||
| * @param is_dir If true, the path is a directory path. | ||
| * @return const char* The constructed file or directory path. |
There was a problem hiding this comment.
@return should not include the type information
| * @brief Constructs a path from the current directory stack. | ||
| * | ||
| * @param is_dir If true, the path is a directory path. | ||
| * @return const char* The constructed file or directory path. |
There was a problem hiding this comment.
Please also add that the returned buffer will only be valid until the next invocation of buildPath
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.
Issues addressed from #93