Document additional commonly-used cJSON functions and types. #145
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
zfields
approved these changes
Mar 26, 2024
n_cjson_helpers.c
Outdated
| /**************************************************************************/ | ||
| @brief Determine if a field is present in a JSON object. | ||
|
|
||
| @param rsp The JSON object. |
There was a problem hiding this comment.
While you're changing things, should we go ahead and rename this parameter j or json?
There was a problem hiding this comment.
I think it would also be nice to have a note describing that false is returned if the JSON object is NULL?
This would allow folks to program against it, instead of guess.
n_cjson_helpers.c
Outdated
| /**************************************************************************/ | ||
| @brief Get the value of a string field from a JSON object. | ||
|
|
||
| @param rsp The JSON object. |
n_cjson_helpers.c
Outdated
| /**************************************************************************/ | ||
| @brief Get the value of an array field from a JSON object. | ||
|
|
||
| @param rsp The JSON object. |
n_cjson_helpers.c
Outdated
| @param field The array field to query. | ||
|
|
||
| @returns A pointer to the array, which is itself a JSON object (`J *`), if the | ||
| field exists and is an array and NULL otherwise. |
There was a problem hiding this comment.
Reading this one, "and and...", made me realize a function only returns one OR the other. It also reads a little easier in my opinion, so I added it to others above.
Suggested change
| field exists and is an array and NULL otherwise. | |
| field exists and is an array, or NULL otherwise. |
There was a problem hiding this comment.
I'm gonna go with "otherwise NULL." I like removing "and", but I feel like "or" and "otherwise" together is wordy and sort of feels redundant.
n_cjson_helpers.c
Outdated
| @param rsp The JSON object. | ||
| @param field The string field to query. | ||
|
|
||
| @returns A pointer to the string if the field exists and is a string and the |
There was a problem hiding this comment.
Suggested change
| @returns A pointer to the string if the field exists and is a string and the | |
| @returns A pointer to the string if the field exists and is a string, or an |
n_cjson_helpers.c
Outdated
Comment on lines
363
to
364
| @returns True if the string was successfully encoded and added to the object | ||
| and false otherwise. |
There was a problem hiding this comment.
Suggested change
| @returns True if the string was successfully encoded and added to the object | |
| and false otherwise. | |
| @returns True if the string was successfully encoded and added to the object, | |
| or false otherwise. |
n_cjson_helpers.c
Outdated
|
|
||
| @param rsp The JSON object. | ||
| @param fieldName The name of the field. | ||
| @param retBinaryData A pointer to a buffer to hold the decoded bytes. |
There was a problem hiding this comment.
Suggested change
| @param retBinaryData A pointer to a buffer to hold the decoded bytes. | |
| @param retBinaryData A pointer to a pointer, used to hold the pointer to the decoded bytes. |
n_cjson_helpers.c
Outdated
Comment on lines
394
to
395
| @param retBinaryDataLen A pointer to a number to hold the length of the decoded | ||
| bytes. |
There was a problem hiding this comment.
Suggested change
| @param retBinaryDataLen A pointer to a number to hold the length of the decoded | |
| bytes. | |
| ```suggestion | |
| @param retBinaryDataLen A pointer to an unsigned integer, used to hold the | |
| length of the decoded bytes. |
n_cjson_helpers.c
Outdated
| @param retBinaryDataLen A pointer to a number to hold the length of the decoded | ||
| bytes. | ||
|
|
||
| @returns True if the string was successfully decoded and returned and false |
There was a problem hiding this comment.
Suggested change
| @returns True if the string was successfully decoded and returned and false | |
| @returns True if the string was successfully decoded and returned, or false |
zfields
approved these changes
Apr 18, 2024
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.