docs: update API docs to reflect output-parameter getter signatures#56
Merged
docs: update API docs to reflect output-parameter getter signatures#56
Conversation
All getter functions (okj_get_string, okj_get_number, okj_get_boolean, okj_get_array, okj_get_object, okj_get_token, okj_get_array_raw, okj_get_object_raw) were refactored from returning typed pointers to returning OkjError with a caller-supplied output struct parameter. Update README.md, wiki/API-Reference.md, and wiki/Usage-Guide.md to: - Show correct three-argument getter signatures with output params - Replace NULL-return semantics with OkjError return code checks - Fix code examples to declare structs and pass their addresses - Remove OKJ_ERROR_TRAILING_CONTENT (not present in current OkjError enum) - Clarify error codes returned on size-limit violations for array/object getters https://claude.ai/code/session_01RqYVgHBmL952SnsPn57Qf9
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
All getter functions (okj_get_string, okj_get_number, okj_get_boolean, okj_get_array, okj_get_object, okj_get_token, okj_get_array_raw, okj_get_object_raw) were refactored from returning typed pointers to returning OkjError with a caller-supplied output struct parameter.
Update README.md, wiki/API-Reference.md, and wiki/Usage-Guide.md to:
https://claude.ai/code/session_01RqYVgHBmL952SnsPn57Qf9