Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document additional commonly-used cJSON functions and types. #145

Merged
merged 2 commits into from
Apr 18, 2024
Merged

Document additional commonly-used cJSON functions and types. #145

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
01eadd2
Document additional commonly-used cJSON functions and types.
haydenroche5 Mar 26, 2024
205ab63
Address review feedback.
haydenroche5 Apr 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/Doxyfile.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -947,6 +947,7 @@ INPUT = @NOTE_C_BASE@/n_hooks.c \
@NOTE_C_BASE@/n_request.c \
@NOTE_C_BASE@/n_cjson.h \
@NOTE_C_BASE@/n_cjson.c \
@NOTE_C_BASE@/n_cjson_helpers.c \
@NOTE_C_BASE@/note.h

# This tag can be used to specify the character encoding of the source files
Expand Down
37 changes: 31 additions & 6 deletions docs/api_reference.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,9 +130,7 @@ JSON Manipulation
Functions
---------

.. doxygenfunction:: JCreateObject

.. doxygenfunction:: JDelete
.. doxygenfunction:: JAddBinaryToObject

.. doxygenfunction:: JAddBoolToObject

Expand All @@ -144,19 +142,46 @@ Functions

.. doxygenfunction:: JAddArrayToObject

.. doxygenfunction:: JParse
.. doxygenfunction:: JCreateObject

.. doxygenfunction:: JPrintUnformatted
.. doxygenfunction:: JDelete

.. doxygenfunction:: JFree

.. doxygenfunction:: JGetArray

.. doxygenfunction:: JGetBinaryFromObject

.. doxygenfunction:: JGetBool

.. doxygenfunction:: JGetInt

.. doxygenfunction:: JGetNumber

.. doxygenfunction:: JGetObject

.. doxygenfunction:: JGetString

.. doxygenfunction:: JIsPresent

.. doxygenfunction:: JMalloc

.. doxygenfunction:: JFree
.. doxygenfunction:: JParse

.. doxygenfunction:: JPrintUnformatted


Types
-----

.. doxygenstruct:: J

.. doxygentypedef:: JNUMBER

.. doxygentypedef:: JINTEGER

.. doxygentypedef:: JUINTEGER

Macros
------

Expand Down
Loading
Loading