You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mynewt.apache.org by ad...@apache.org on 2016/05/09 20:32:06 UTC
[1/4] incubator-mynewt-site git commit: libs/json;
Start documenting the API. Missing array docs and examples.
Repository: incubator-mynewt-site
Updated Branches:
refs/heads/master 528c255b8 -> 9d284d5d6
libs/json; Start documenting the API. Missing array docs and
examples.
Project: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/commit/2dc74349
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/2dc74349
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/2dc74349
Branch: refs/heads/master
Commit: 2dc74349ba377d6092c9be587f7ac42be7be43b1
Parents: 457a140
Author: Marko Kiiskila <ma...@runtime.io>
Authored: Sat May 7 08:35:56 2016 -0700
Committer: Marko Kiiskila <ma...@runtime.io>
Committed: Sat May 7 08:35:56 2016 -0700
----------------------------------------------------------------------
docs/os/modules/json/json.md | 115 ++++++++++++++++---
.../os/modules/json/json_encode_object_entry.md | 24 ++++
.../modules/json/json_encode_object_finish.md | 22 ++++
docs/os/modules/json/json_encode_object_key.md | 23 ++++
.../os/modules/json/json_encode_object_start.md | 23 ++++
docs/os/modules/json/json_encode_value.md | 0
.../modules/json/json_internal_read_object.md | 0
docs/os/modules/json/json_read_array.md | 0
docs/os/modules/json/json_read_object.md | 22 ++++
docs/os/modules/json/json_target_address.md | 0
10 files changed, 216 insertions(+), 13 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/2dc74349/docs/os/modules/json/json.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/json/json.md b/docs/os/modules/json/json.md
index 4e1f920..9faf9e7 100644
--- a/docs/os/modules/json/json.md
+++ b/docs/os/modules/json/json.md
@@ -1,28 +1,117 @@
# JSON
-Insert synopsis here
-
+JSON is a data interchange format. The description of this format can be found from IETF RFC 4627.
## Description
-Describe module here, special features, how pieces fit together etc.
+This package helps in converting between C data types and JSON data objects. It supports both encoding and decoding.
## Data structures
-Replace this with the list of data structures used, why, any neat features
+### Encoding
-## List of Functions
+```c
+/* Encoding functions */
+typedef int (*json_write_func_t)(void *buf, char *data,
+ int len);
+
+struct json_encoder {
+ json_write_func_t je_write;
+ void *je_arg;
+ int je_wr_commas:1;
+ char je_encode_buf[64];
+};
+```
+Here's the data structure encoder funtions use, and it must be initialized by the caller. The key element is *je_write*, which is a function pointer which gets called whenever encoding routine is ready with encoded data. The element *je_arg* is passed to *je_write* as the first argument. The rest of the structure contents are for internal state management.
+This function should collect all the data encoder function generates. It can collect this data to a flat buffer, chain of mbufs or even stream through.
+
+```c
+/**
+ * For encode. The contents of a JSON value to encode.
+ */
+struct json_value {
+ uint8_t jv_pad1;
+ uint8_t jv_type;
+ uint16_t jv_len;
+
+ union {
+ uint64_t u;
+ float fl;
+ char *str;
+ struct {
+ char **keys;
+ struct json_value **values;
+ } composite;
+ } jv_val;
+};
+```
+This data structure is filled with data to be encoded. It is best to fill this using the macros *JSON_VALUE_STRING()* or *JSON_VALUE_STRINGN()* when value is string, *JSON_VALUE_INT()* when value is an integer, and so forth.
+
+###Decoding
+```c
+/* when you implement a json buffer, you must implement these functions */
+
+/* returns the next character in the buffer or '\0'*/
+typedef char (*json_buffer_read_next_byte_t)(struct json_buffer *);
+/* returns the previous character in the buffer or '\0' */
+typedef char (*json_buffer_read_prev_byte_t)(struct json_buffer *);
+/* returns the number of characters read or zero */
+typedef int (*json_buffer_readn_t)(struct json_buffer *, char *buf, int n);
+
+struct json_buffer {
+ json_buffer_readn_t jb_readn;
+ json_buffer_read_next_byte_t jb_read_next;
+ json_buffer_read_prev_byte_t jb_read_prev;
+};
+```
+Function pointers within this structure are used by decoder when it is reading in more data to decode.
-<Comments such as these instructions are placed within angle brackets. List all the functions here. Note how the anchors work. You put the text you want to show up as a link within [] and the relevant #heading within (). Note that the header has to have at least 2 words for the anchor to work - that's how it is. "no-highlight" disables syntax highlighting. You can enable it for a particular language by specifying what the language is instead of "no-highlight". Be warned that this highlighting or no-highlighting specification may not show up nicely on Mou.>
+```c
+struct json_attr_t {
+ char *attribute;
+ json_type type;
+ union {
+ int *integer;
+ unsigned int *uinteger;
+ double *real;
+ char *string;
+ bool *boolean;
+ char *character;
+ struct json_array_t array;
+ size_t offset;
+ } addr;
+ union {
+ int integer;
+ unsigned int uinteger;
+ double real;
+ bool boolean;
+ char character;
+ char *check;
+ } dflt;
+ size_t len;
+ const struct json_enum_t *map;
+ bool nodefault;
+};
+```
+This structure tells the decoder about a particular name/value pair. Structure must be filled in before calling the decoder routine *json_read_object()*.
-The functions available in json are:
+| Element | Description |
+|---------|-------------|
+| attribute | Name of the value |
+| type | The type of the variable; see enum json_type |
+| addr | Contains the address where value should be stored |
+| dflt | Default value to fill in, if this name is not found |
+| len | Max number of bytes to read in for value |
+| nodefault | If set, default value is not copied name |
+## List of Functions
+
+Functions for encoding:
+
+* [json_encode_object_start](json_encode_object_start.md)
+* [json_encode_object_key](json_encode_object_key.md)
* [json_encode_object_entry](json_encode_object_entry.md)
* [json_encode_object_finish](json_encode_object_finish.md)
-* [json_encode_object_key](json_encode_object_key.md)
-* [json_encode_object_start](json_encode_object_start.md)
-* [json_encode_value](json_encode_value.md)
-* [json_internal_read_object](json_internal_read_object.md)
-* [json_read_array](json_read_array.md)
+
+Functions for decoding:
* [json_read_object](json_read_object.md)
-* [json_target_address](json_target_address.md)
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/2dc74349/docs/os/modules/json/json_encode_object_entry.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/json/json_encode_object_entry.md b/docs/os/modules/json/json_encode_object_entry.md
index e69de29..900461d 100644
--- a/docs/os/modules/json/json_encode_object_entry.md
+++ b/docs/os/modules/json/json_encode_object_entry.md
@@ -0,0 +1,24 @@
+## <font color="#F2853F" style="font-size:24pt"> json_encode_object_entry </font>
+
+```no-highlight
+ int json_encode_object_entry(struct json_encoder *encoder, char *key, struct json_value *val)
+```
+
+This function writes out a name for a field, followed by ":" character, and the value itself. How value is treated depends on the type of the value.
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| encoder | json_encoder to use |
+| key | name to write out |
+| val | value to write out |
+
+
+#### Returned values
+
+0 on success.
+
+#### Notes
+
+#### Example
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/2dc74349/docs/os/modules/json/json_encode_object_finish.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/json/json_encode_object_finish.md b/docs/os/modules/json/json_encode_object_finish.md
index e69de29..823b829 100644
--- a/docs/os/modules/json/json_encode_object_finish.md
+++ b/docs/os/modules/json/json_encode_object_finish.md
@@ -0,0 +1,22 @@
+## <font color="#F2853F" style="font-size:24pt"> json_encode_object_finish </font>
+
+```no-highlight
+ int json_encode_object_finish(struct json_encoder *encoder)
+```
+
+This function finalizes the encoded JSON object. This means writing out the last "}" character.
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| encoder | json_encoder to use |
+
+
+#### Returned values
+
+0 on success.
+
+#### Notes
+
+#### Example
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/2dc74349/docs/os/modules/json/json_encode_object_key.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/json/json_encode_object_key.md b/docs/os/modules/json/json_encode_object_key.md
index e69de29..8d4f3d1 100644
--- a/docs/os/modules/json/json_encode_object_key.md
+++ b/docs/os/modules/json/json_encode_object_key.md
@@ -0,0 +1,23 @@
+## <font color="#F2853F" style="font-size:24pt"> json_encode_object_key </font>
+
+```no-highlight
+ int json_encode_object_key(struct json_encoder *encoder, char *key)
+```
+
+This function writes out a name for a field, followed by ":" character. You would use this e.g. when the value that follows is a JSON object.
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| encoder | json_encoder to use |
+| key | name to write out |
+
+
+#### Returned values
+
+0 on success.
+
+#### Notes
+
+#### Example
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/2dc74349/docs/os/modules/json/json_encode_object_start.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/json/json_encode_object_start.md b/docs/os/modules/json/json_encode_object_start.md
index e69de29..b24b851 100644
--- a/docs/os/modules/json/json_encode_object_start.md
+++ b/docs/os/modules/json/json_encode_object_start.md
@@ -0,0 +1,23 @@
+## <font color="#F2853F" style="font-size:24pt"> json_encode_object_start </font>
+
+```no-highlight
+ int json_encode_object_start(struct json_encoder *encoder)
+```
+
+This function starts the encoded JSON object. Usually this means writing out the initial "{" character.
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| encoder | json_encoder to use |
+
+
+#### Returned values
+
+0 on success.
+
+#### Notes
+
+#### Example
+
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/2dc74349/docs/os/modules/json/json_encode_value.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/json/json_encode_value.md b/docs/os/modules/json/json_encode_value.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/2dc74349/docs/os/modules/json/json_internal_read_object.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/json/json_internal_read_object.md b/docs/os/modules/json/json_internal_read_object.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/2dc74349/docs/os/modules/json/json_read_array.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/json/json_read_array.md b/docs/os/modules/json/json_read_array.md
deleted file mode 100644
index e69de29..0000000
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/2dc74349/docs/os/modules/json/json_read_object.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/json/json_read_object.md b/docs/os/modules/json/json_read_object.md
index e69de29..a8f6bda 100644
--- a/docs/os/modules/json/json_read_object.md
+++ b/docs/os/modules/json/json_read_object.md
@@ -0,0 +1,22 @@
+## <font color="#F2853F" style="font-size:24pt"> json_read_object </font>
+
+```no-highlight
+ int json_read_object(struct json_buffer *jb, const struct json_attr_t *attrs)
+```
+
+This function reads in JSON data stream, while looking for name/value pairs described in *attrs*. *attrs* is an array; end of the array is indicated by an entry with *NULL* as the name.
+
+#### Arguments
+
+| Arguments | Description |
+|-----------|-------------|
+| jb | json_decoder to use |
+| attrs | array of attributes to look for |
+
+#### Returned values
+
+0 on success.
+
+#### Notes
+
+#### Example
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/2dc74349/docs/os/modules/json/json_target_address.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/json/json_target_address.md b/docs/os/modules/json/json_target_address.md
deleted file mode 100644
index e69de29..0000000
[3/4] incubator-mynewt-site git commit: Merge branch 'json' of
https://github.com/mkiiskila/incubator-mynewt-site
Posted by ad...@apache.org.
Merge branch 'json' of https://github.com/mkiiskila/incubator-mynewt-site
This closes #79
Project: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/commit/9ad7f6b0
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/9ad7f6b0
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/9ad7f6b0
Branch: refs/heads/master
Commit: 9ad7f6b04d14ee267a5f7e70551ad1a648a9c860
Parents: 528c255 72578fe
Author: aditihilbert <ad...@runtime.io>
Authored: Mon May 9 10:26:25 2016 -0700
Committer: aditihilbert <ad...@runtime.io>
Committed: Mon May 9 10:26:25 2016 -0700
----------------------------------------------------------------------
docs/os/modules/json/json.md | 115 ++++++++++++++++---
.../os/modules/json/json_encode_object_entry.md | 42 +++++++
.../modules/json/json_encode_object_finish.md | 40 +++++++
docs/os/modules/json/json_encode_object_key.md | 41 +++++++
.../os/modules/json/json_encode_object_start.md | 40 +++++++
docs/os/modules/json/json_encode_value.md | 0
.../modules/json/json_internal_read_object.md | 0
docs/os/modules/json/json_read_array.md | 0
docs/os/modules/json/json_read_object.md | 60 ++++++++++
docs/os/modules/json/json_target_address.md | 0
10 files changed, 325 insertions(+), 13 deletions(-)
----------------------------------------------------------------------
[2/4] incubator-mynewt-site git commit: json;
add example code snippets.
Posted by ad...@apache.org.
json; add example code snippets.
Project: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/commit/72578fe4
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/72578fe4
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/72578fe4
Branch: refs/heads/master
Commit: 72578fe431aadd21de0a118d78e010b687b512b0
Parents: 2dc7434
Author: Marko Kiiskila <ma...@runtime.io>
Authored: Mon May 9 07:54:29 2016 -0700
Committer: Marko Kiiskila <ma...@runtime.io>
Committed: Mon May 9 07:54:29 2016 -0700
----------------------------------------------------------------------
.../os/modules/json/json_encode_object_entry.md | 18 ++++++++++
.../modules/json/json_encode_object_finish.md | 18 ++++++++++
docs/os/modules/json/json_encode_object_key.md | 18 ++++++++++
.../os/modules/json/json_encode_object_start.md | 17 +++++++++
docs/os/modules/json/json_read_object.md | 38 ++++++++++++++++++++
5 files changed, 109 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/72578fe4/docs/os/modules/json/json_encode_object_entry.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/json/json_encode_object_entry.md b/docs/os/modules/json/json_encode_object_entry.md
index 900461d..a88aa57 100644
--- a/docs/os/modules/json/json_encode_object_entry.md
+++ b/docs/os/modules/json/json_encode_object_entry.md
@@ -22,3 +22,21 @@ This function writes out a name for a field, followed by ":" character, and the
#### Notes
#### Example
+
+```c
+static int
+imgr_list(struct nmgr_jbuf *njb)
+{
+ struct json_encoder *enc;
+ struct json_value array;
+
+ ...
+
+ json_encode_object_start(enc);
+ json_encode_object_entry(enc, "images", &array);
+ json_encode_object_finish(enc);
+
+ return 0;
+}
+
+```
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/72578fe4/docs/os/modules/json/json_encode_object_finish.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/json/json_encode_object_finish.md b/docs/os/modules/json/json_encode_object_finish.md
index 823b829..87106ed 100644
--- a/docs/os/modules/json/json_encode_object_finish.md
+++ b/docs/os/modules/json/json_encode_object_finish.md
@@ -20,3 +20,21 @@ This function finalizes the encoded JSON object. This means writing out the last
#### Notes
#### Example
+
+```c
+static int
+imgr_list(struct nmgr_jbuf *njb)
+{
+ struct json_encoder *enc;
+ struct json_value array;
+
+ ...
+
+ json_encode_object_start(enc);
+ json_encode_object_entry(enc, "images", &array);
+ json_encode_object_finish(enc);
+
+ return 0;
+}
+
+```
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/72578fe4/docs/os/modules/json/json_encode_object_key.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/json/json_encode_object_key.md b/docs/os/modules/json/json_encode_object_key.md
index 8d4f3d1..6f93ead 100644
--- a/docs/os/modules/json/json_encode_object_key.md
+++ b/docs/os/modules/json/json_encode_object_key.md
@@ -21,3 +21,21 @@ This function writes out a name for a field, followed by ":" character. You woul
#### Notes
#### Example
+
+```c
+int
+nmgr_def_taskstat_read(struct nmgr_jbuf *njb)
+{
+ ...
+
+ struct json_value jv;
+
+ json_encode_object_start(&njb->njb_enc);
+ JSON_VALUE_INT(&jv, NMGR_ERR_EOK);
+ json_encode_object_entry(&njb->njb_enc, "rc", &jv);
+
+ json_encode_object_key(&njb->njb_enc, "tasks");
+ json_encode_object_start(&njb->njb_enc);
+ ...
+}
+```
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/72578fe4/docs/os/modules/json/json_encode_object_start.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/json/json_encode_object_start.md b/docs/os/modules/json/json_encode_object_start.md
index b24b851..3554c53 100644
--- a/docs/os/modules/json/json_encode_object_start.md
+++ b/docs/os/modules/json/json_encode_object_start.md
@@ -21,3 +21,20 @@ This function starts the encoded JSON object. Usually this means writing out the
#### Example
+```c
+static int
+imgr_list(struct nmgr_jbuf *njb)
+{
+ struct json_encoder *enc;
+ struct json_value array;
+
+ ...
+
+ json_encode_object_start(enc);
+ json_encode_object_entry(enc, "images", &array);
+ json_encode_object_finish(enc);
+
+ return 0;
+}
+
+```
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/72578fe4/docs/os/modules/json/json_read_object.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/json/json_read_object.md b/docs/os/modules/json/json_read_object.md
index a8f6bda..90dfac4 100644
--- a/docs/os/modules/json/json_read_object.md
+++ b/docs/os/modules/json/json_read_object.md
@@ -20,3 +20,41 @@ This function reads in JSON data stream, while looking for name/value pairs desc
#### Notes
#### Example
+
+```c
+
+static int
+imgr_upload(struct nmgr_jbuf *njb)
+{
+ ...
+ const struct json_attr_t off_attr[4] = {
+ [0] = {
+ .attribute = "off",
+ .type = t_uinteger,
+ .addr.uinteger = &off,
+ .nodefault = true
+ },
+ [1] = {
+ .attribute = "data",
+ .type = t_string,
+ .addr.string = img_data,
+ .len = sizeof(img_data)
+ },
+ [2] = {
+ .attribute = "len",
+ .type = t_uinteger,
+ .addr.uinteger = &size,
+ .nodefault = true
+ }
+ };
+ ...
+
+ rc = json_read_object(&njb->njb_buf, off_attr);
+ if (rc || off == UINT_MAX) {
+ rc = OS_EINVAL;
+ goto err;
+ }
+ ...
+}
+
+```
[4/4] incubator-mynewt-site git commit: removed page listing for
deleted files from mkdocs.yml, minor formatting changes to json docs
Posted by ad...@apache.org.
removed page listing for deleted files from mkdocs.yml, minor formatting changes to json docs
Project: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/commit/9d284d5d
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/9d284d5d
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/9d284d5d
Branch: refs/heads/master
Commit: 9d284d5d691cfe86fd2a597d67392b645661cfc3
Parents: 9ad7f6b
Author: aditihilbert <ad...@runtime.io>
Authored: Mon May 9 13:22:36 2016 -0700
Committer: aditihilbert <ad...@runtime.io>
Committed: Mon May 9 13:22:36 2016 -0700
----------------------------------------------------------------------
docs/os/modules/json/json.md | 1 +
docs/os/modules/json/json_encode_object_entry.md | 2 +-
docs/os/modules/json/json_encode_object_finish.md | 2 +-
docs/os/modules/json/json_encode_object_key.md | 2 +-
docs/os/modules/json/json_encode_object_start.md | 2 +-
docs/os/modules/json/json_read_object.md | 2 +-
mkdocs.yml | 7 +++----
7 files changed, 9 insertions(+), 9 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9d284d5d/docs/os/modules/json/json.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/json/json.md b/docs/os/modules/json/json.md
index 9faf9e7..0297477 100644
--- a/docs/os/modules/json/json.md
+++ b/docs/os/modules/json/json.md
@@ -114,4 +114,5 @@ Functions for encoding:
* [json_encode_object_finish](json_encode_object_finish.md)
Functions for decoding:
+
* [json_read_object](json_read_object.md)
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9d284d5d/docs/os/modules/json/json_encode_object_entry.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/json/json_encode_object_entry.md b/docs/os/modules/json/json_encode_object_entry.md
index a88aa57..c2124dc 100644
--- a/docs/os/modules/json/json_encode_object_entry.md
+++ b/docs/os/modules/json/json_encode_object_entry.md
@@ -19,7 +19,7 @@ This function writes out a name for a field, followed by ":" character, and the
0 on success.
-#### Notes
+
#### Example
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9d284d5d/docs/os/modules/json/json_encode_object_finish.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/json/json_encode_object_finish.md b/docs/os/modules/json/json_encode_object_finish.md
index 87106ed..762a5c3 100644
--- a/docs/os/modules/json/json_encode_object_finish.md
+++ b/docs/os/modules/json/json_encode_object_finish.md
@@ -17,7 +17,7 @@ This function finalizes the encoded JSON object. This means writing out the last
0 on success.
-#### Notes
+
#### Example
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9d284d5d/docs/os/modules/json/json_encode_object_key.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/json/json_encode_object_key.md b/docs/os/modules/json/json_encode_object_key.md
index 6f93ead..3432941 100644
--- a/docs/os/modules/json/json_encode_object_key.md
+++ b/docs/os/modules/json/json_encode_object_key.md
@@ -18,7 +18,7 @@ This function writes out a name for a field, followed by ":" character. You woul
0 on success.
-#### Notes
+
#### Example
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9d284d5d/docs/os/modules/json/json_encode_object_start.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/json/json_encode_object_start.md b/docs/os/modules/json/json_encode_object_start.md
index 3554c53..62e9010 100644
--- a/docs/os/modules/json/json_encode_object_start.md
+++ b/docs/os/modules/json/json_encode_object_start.md
@@ -17,7 +17,7 @@ This function starts the encoded JSON object. Usually this means writing out the
0 on success.
-#### Notes
+
#### Example
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9d284d5d/docs/os/modules/json/json_read_object.md
----------------------------------------------------------------------
diff --git a/docs/os/modules/json/json_read_object.md b/docs/os/modules/json/json_read_object.md
index 90dfac4..e8a6ddd 100644
--- a/docs/os/modules/json/json_read_object.md
+++ b/docs/os/modules/json/json_read_object.md
@@ -17,7 +17,7 @@ This function reads in JSON data stream, while looking for name/value pairs desc
0 on success.
-#### Notes
+
#### Example
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/9d284d5d/mkdocs.yml
----------------------------------------------------------------------
diff --git a/mkdocs.yml b/mkdocs.yml
index 3684e57..fe6177b 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -303,11 +303,10 @@ pages:
- 'json_encode_object_finish': 'os/modules/json/json_encode_object_finish.md'
- 'json_encode_object_key': 'os/modules/json/json_encode_object_key.md'
- 'json_encode_object_start': 'os/modules/json/json_encode_object_start.md'
- - 'json_encode_value': 'os/modules/json/json_encode_value.md'
- - 'json_internal_read_object': 'os/modules/json/json_internal_read_object.md'
- - 'json_read_array': 'os/modules/json/json_read_array.md'
+# - 'json_encode_value': 'os/modules/json/json_encode_value.md'
+# - 'json_read_array': 'os/modules/json/json_read_array.md'
- 'json_read_object': 'os/modules/json/json_read_object.md'
- - 'json_target_address': 'os/modules/json/json_target_address.md'
+# - 'json_target_address': 'os/modules/json/json_target_address.md'
- Stats:
- toc: 'os/modules/stats/stats.md'
- Logs: