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

* Document additional commonly-used cJSON functions and types. * Address review feedback.
blues · Apr 18, 2024 · 168490e · 168490e
1 parent 34736e4
commit 168490e
Show file tree

Hide file tree

Showing 4 changed files with 208 additions and 134 deletions.
diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in
@@ -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

diff --git a/docs/api_reference.rst b/docs/api_reference.rst
@@ -130,9 +130,7 @@ JSON Manipulation
 Functions
 ---------
 
-.. doxygenfunction:: JCreateObject
-
-.. doxygenfunction:: JDelete
+.. doxygenfunction:: JAddBinaryToObject
 
 .. doxygenfunction:: JAddBoolToObject
 
@@ -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
 ------