Improve Doxygen comments in n_request.c. #80
Merged
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
haydenroche5
commented
Jun 15, 2023
|
@zfields changed |
|
Can you resolve the conflicts now that we've reworked a bunch of stuff? |
Yep. Should be good to go now. |
zfields
approved these changes
Oct 2, 2023
| */ | ||
| /**************************************************************************/ | ||
| @brief Check to see if a Notecard error is present in a JSON string. | ||
|
|
There was a problem hiding this comment.
Only Notecard errors enclosed in {} (e.g. {io} for an I/O error) are guaranteed by the API.
There was a problem hiding this comment.
I was hoping you would fashion that into the long description, similar to NoteErrorClean() below.
FWIW, I normally throw @notes at the bottom, not that it matters.
zfields
approved these changes
Oct 2, 2023
| */ | ||
| /**************************************************************************/ | ||
| @brief Check to see if a Notecard error is present in a JSON string. | ||
|
|
There was a problem hiding this comment.
I was hoping you would fashion that into the long description, similar to NoteErrorClean() below.
FWIW, I normally throw @notes at the bottom, not that it matters.
Also, make them all conform to the same style.
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.
Also, make them all conform to the same style.
This is a step toward generating the API docs for note-c. I'll tackle the other source files next, and eventually will come up with a scheme for generating and publishing the docs somewhere.