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:34:03 UTC
[1/2] incubator-mynewt-site git commit: added json function call
descriptions - pull request #70 by Marko Kiiskila
Repository: incubator-mynewt-site
Updated Branches:
refs/heads/asf-site 13287a3c2 -> d4c7aea62
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/d4c7aea6/os/modules/json/json_read_array/index.html
----------------------------------------------------------------------
diff --git a/os/modules/json/json_read_array/index.html b/os/modules/json/json_read_array/index.html
deleted file mode 100644
index 22265a5..0000000
--- a/os/modules/json/json_read_array/index.html
+++ /dev/null
@@ -1,713 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <meta charset="utf-8">
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
-
-
- <link rel="canonical" href="http://mynewt.apache.org/os/modules/json/json_read_array/">
- <link rel="shortcut icon" href="../../../../img/favicon.ico">
-
- <title>json_read_array - Apache Mynewt</title>
-
- <link href="../../../../css/bootstrap-3.0.3.min.css" rel="stylesheet">
- <link href="../../../../css/font-awesome-4.0.3.css" rel="stylesheet">
- <link rel="stylesheet" href="../../../../css/highlight.css">
- <link href="../../../../css/base.css" rel="stylesheet">
- <link href="../../../../css/custom.css" rel="stylesheet">
- <link href='https://fonts.googleapis.com/css?family=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'>
- <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
- <link href="../../../../extra.css" rel="stylesheet">
-
- <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
- <!--[if lt IE 9]>
- <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
- <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
- <![endif]-->
-
-
- <script>
- (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
- (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
- m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
- })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
-
- ga('create', 'UA-72162311-1', 'mynewt.incubator.apache.org');
- ga('send', 'pageview');
- </script>
-
- </head>
-
-
- <body class="json_read_array">
-
-
- <div id="navbar" class="navbar navbar-default navbar-fixed-top" role="navigation">
- <div class="logo-container">
- <img src="/img/logo.svg">
- </div>
- <div class="container-fluid">
- <!-- Collapsed navigation -->
- <div class="navbar-header">
- <!-- Expander button -->
- <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
- <span class="sr-only">Toggle navigation</span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- </button>
-
- </div>
-
- <!-- Expanded navigation -->
- <div class="navbar-collapse collapse">
- <!-- Main navigation -->
- <ul class="nav navbar-nav navbar-right">
- <li>
- <a href="/">Home</a>
- </li>
- <li>
- <a href="/about/">About</a>
- </li>
- <li class="dropdown">
- <a href="/documentation/" class="dropdown-toggle" data-toggle="dropdown">Docs <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-
-
-
-
- <li >
- <a href="../../../../documentation/">
- Overview
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="active">
- <a href="../../../get_started/introduction/">
- Mynewt OS Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../../newt/newt_intro/">
- Newt Tool Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../../newtmgr/overview/">
- Newt Manager Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../tutorials/how_to_edit_docs/">
- Appendix
- </a>
- </li>
-
-
- </ul>
- </li>
- <li>
- <a href="/download/">Download</a>
- </li>
- <li>
- <a href="/community/">Community</a>
- </li>
- <li>
- <a href="/events/">Events</a>
- </li>
- </ul>
-
- <!-- Search, Navigation and Repo links -->
- <ul class="nav navbar-nav navbar-right">
-
- </ul>
- </div>
- </div>
-</div>
-
-
-
- <div class="container-fluid">
-
- <div class="row sm-extra-padding">
- <div id="docSidebar" class="col-md-3 bg-grey sidebar-container"><div class="bs-sidebar hidden-print" role="complementary">
- <div class="sidebar-top">
- <img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt">
- <div class="small" role="search">
- <form id ="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
- <div class="form-group">
- <input type="text" name="q" placeholder="Search documentation" />
- <button class="search-button" type="submit"><i class="fa fa-search"></i></button>
- </div>
- </form>
- </div>
- </div>
- <ul class="nav bs-sidenav">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li><a href="
- ../../../get_started/introduction/
-">Mynewt OS Manual</a>
-
-
- <ul class="current-toc">
-
-
-
-
- <li>
- <a href="../../../get_started/introduction/">Introduction</a>
- </li>
-
-
-
-
-
-
-
-
- <li ><a href="../../../get_started/get_started/">Quick Start</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../../get_started/vocabulary/">Concepts</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../../tutorials/tutorials/">Tutorials</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../../os_user_guide/">OS User Guide</a></li>
-
-
- <ul class="current-toc">
-
-
-
-
-
-
-
- <li ><a href="../../../core_os/mynewt_os/">OS Core</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../../core_os/porting/port_os/">Porting to your Platform</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../console/console/">Console</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../shell/shell/">Shell</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../bootloader/bootloader/">Bootloader</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li><a href="
-
-
- ../../fs/fs/fs/
-
-">File System</a>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../hal/hal/">Hardware Abstraction Layer</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../testutil/testutil/">Test Utilities</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../imgmgr/imgmgr/">Image Manager</a></li>
-
-
- </li>
-
-
-
-
-
-
- <li>
- <a href="../../baselibc/">Baselibc library</a>
- </li>
-
-
-
-
-
-
-
-
- <li ><a href="../../elua/elua/">Embedded Lua</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../json/">JSON</a></li>
-
-
- <ul class="current-toc">
-
-
-
-
-
-
-
- <li><a href="
- ../json_encode_object_entry/
-">Functions</a>
-
-
- <ul class="current-toc">
-
-
-
-
- <li>
- <a href="../json_encode_object_entry/">json_encode_object_entry</a>
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_encode_object_finish/">json_encode_object_finish</a>
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_encode_object_key/">json_encode_object_key</a>
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_encode_object_start/">json_encode_object_start</a>
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_encode_value/">json_encode_value</a>
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_internal_read_object/">json_internal_read_object</a>
- </li>
-
-
-
-
-
-
-
- <li class="active">
- json_read_array
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_read_object/">json_read_object</a>
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_target_address/">json_target_address</a>
- </li>
-
-
-
-
- </ul>
-
- </li>
-
-
-
- </ul>
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../stats/stats/">Stats</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../logs/logs/">Logs</a></li>
-
-
- </li>
-
-
-
- </ul>
-
- </li>
-
-
-
-
-
-
-
- <li><a href="
- ../../../../network/ble/ble_intro/
-">BLE User Guide</a>
-
-
- </li>
-
-
-
- </ul>
-
- </li>
-
-
-
-
-
-
-
- <li><a href="
- ../../../../newt/newt_intro/
-">Newt Tool Manual</a>
-
-
- </li>
-
-
-
-
-
-
-
- <li><a href="
- ../../../../newtmgr/overview/
-">Newt Manager Manual</a>
-
-
- </li>
-
-
-
-
-
-
-
- <li><a href="
- ../../../tutorials/how_to_edit_docs/
-">Appendix</a>
-
-
- </li>
-
-
-
- </ul>
-</div></div>
-
- <div class="show-sidebar-container">
- <button class="show-sidebar">Docs Menu</button>
- </div>
-
- <div class="col-md-offset-3 col-md-9 documentation-viewer" role="main">
- <div class="row doc-header">
- <div class="col-sm-6">
-
-<ul class="nav nav-pills">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="active" role="presentation"><a href="../../../get_started/introduction/">Mynewt OS</a></li>
-
-
-
- <li role="presentation"><a href="../../../../newt/newt_intro/">Newt Tool</a></li>
-
-
-
- <li role="presentation"><a href="../../../../newtmgr/overview/">Newt Mgr</a></li>
-
-
-
-
-</ul>
- </div>
- <div class="col-sm-6">
- <div role="navigation" aria-label="breadcrumbs navigation">
- <ul class="wy-breadcrumbs">
- <li><a href="/documentation/">Docs</a></li>
-
-
-
- <li>» <a href="../json/">JSON</a></li>
-
-
-
- <li>» <a href="../json_encode_object_entry/">Functions</a></li>
-
-
-
- <li>» json_read_array</li>
-
-
-
- </ul>
-</div>
- </div>
- </div>
-
-
-
- <div class="row">
-
-
-
-
-<ul class="nav nav-pills" style="margin-bottom: 10px">
- <li>
-
- <a href=../json_internal_read_object/>
- <span class="fa fa-arrow-left"></span>
- Previous: json_internal_read_object
- </a>
-
- </li>
- <li class="pull-right">
-
- <a href=../json_read_object/>
- Next: json_read_object
- <span class="fa fa-arrow-right"></span>
- </a>
-
- </li>
-</ul>
- </div>
- <div class="row">
- <footer>
- <div class="row">
- <div class="col-md-12">
-
- <p class="copyright">Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0 Apache and the Apache feather logo are trademarks of The Apache Software Foundation.<br>The Apache Software Foundation Apache Incubator</p>
-
- </div>
- </div>
- <div class="copyright-logos">
- <div class="row">
- <div class="col-xs-6 text-right">
- <img src="/img/apache-feather.png" alt="Apache" title="Apache">
- </div>
- <div class="col-xs-6 text-left">
- <img src="/img/apache-logo.png" alt="Apache Incubator" title="Apache Incubator">
- </div>
- </div>
- </div>
- <div class="row">
- <div class="col-md-12">
- <small class="footnote">
- MyNewt is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
- </small>
- </div>
- </div>
-</footer>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <script src="../../../../js/jquery-1.10.2.min.js"></script>
- <script src="../../../../js/bootstrap-3.0.3.min.js"></script>
- <script src="../../../../js/highlight.pack.js"></script>
- <script src="../../../../js/base.js"></script>
- <script src="../../../../js/custom.js"></script>
-
- </body>
-</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/d4c7aea6/os/modules/json/json_read_object/index.html
----------------------------------------------------------------------
diff --git a/os/modules/json/json_read_object/index.html b/os/modules/json/json_read_object/index.html
index d0f050f..bc4ce45 100644
--- a/os/modules/json/json_read_object/index.html
+++ b/os/modules/json/json_read_object/index.html
@@ -431,36 +431,6 @@
- <li>
- <a href="../json_encode_value/">json_encode_value</a>
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_internal_read_object/">json_internal_read_object</a>
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_read_array/">json_read_array</a>
- </li>
-
-
-
-
-
-
-
<li class="active">
json_read_object
</li>
@@ -468,16 +438,6 @@
-
-
-
- <li>
- <a href="../json_target_address/">json_target_address</a>
- </li>
-
-
-
-
</ul>
</li>
@@ -643,7 +603,68 @@
</div>
</div>
-
+ <h2 id="json_read_object"><font color="#F2853F" style="font-size:24pt"> json_read_object </font><a class="headerlink" href="#json_read_object" title="Permanent link">¶</a></h2>
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> int json_read_object(struct json_buffer *jb, const struct json_attr_t *attrs)
+</pre></div>
+
+
+<p>This function reads in JSON data stream, while looking for name/value pairs described in <em>attrs</em>. <em>attrs</em> is an array; end of the array is indicated by an entry with <em>NULL</em> as the name.</p>
+<h4 id="arguments">Arguments<a class="headerlink" href="#arguments" title="Permanent link">¶</a></h4>
+<table>
+<thead>
+<tr>
+<th>Arguments</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>jb</td>
+<td>json_decoder to use</td>
+</tr>
+<tr>
+<td>attrs</td>
+<td>array of attributes to look for</td>
+</tr>
+</tbody>
+</table>
+<h4 id="returned-values">Returned values<a class="headerlink" href="#returned-values" title="Permanent link">¶</a></h4>
+<p>0 on success.</p>
+<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">static</span> <span style="color: #A90D91">int</span>
+<span style="color: #000000">imgr_upload</span>(<span style="color: #A90D91">struct</span> <span style="color: #000000">nmgr_jbuf</span> <span style="color: #000000">*njb</span>)
+{
+ ...
+ <span style="color: #A90D91">const</span> <span style="color: #A90D91">struct</span> <span style="color: #A90D91">json_attr_t</span> <span style="color: #000000">off_attr</span>[<span style="color: #1C01CE">4</span>] <span style="color: #000000">=</span> {
+ [<span style="color: #1C01CE">0</span>] <span style="color: #000000">=</span> {
+ .<span style="color: #000000">attribute</span> <span style="color: #000000">=</span> <span style="color: #C41A16">"off"</span>,
+ .<span style="color: #000000">type</span> <span style="color: #000000">=</span> <span style="color: #000000">t_uinteger</span>,
+ .<span style="color: #000000">addr</span>.<span style="color: #000000">uinteger</span> <span style="color: #000000">=</span> <span style="color: #000000">&off</span>,
+ .<span style="color: #000000">nodefault</span> <span style="color: #000000">=</span> <span style="color: #A90D91">true</span>
+ },
+ [<span style="color: #1C01CE">1</span>] <span style="color: #000000">=</span> {
+ .<span style="color: #000000">attribute</span> <span style="color: #000000">=</span> <span style="color: #C41A16">"data"</span>,
+ .<span style="color: #000000">type</span> <span style="color: #000000">=</span> <span style="color: #000000">t_string</span>,
+ .<span style="color: #000000">addr</span>.<span style="color: #000000">string</span> <span style="color: #000000">=</span> <span style="color: #000000">img_data</span>,
+ .<span style="color: #000000">len</span> <span style="color: #000000">=</span> <span style="color: #A90D91">sizeof</span>(<span style="color: #000000">img_data</span>)
+ },
+ [<span style="color: #1C01CE">2</span>] <span style="color: #000000">=</span> {
+ .<span style="color: #000000">attribute</span> <span style="color: #000000">=</span> <span style="color: #C41A16">"len"</span>,
+ .<span style="color: #000000">type</span> <span style="color: #000000">=</span> <span style="color: #000000">t_uinteger</span>,
+ .<span style="color: #000000">addr</span>.<span style="color: #000000">uinteger</span> <span style="color: #000000">=</span> <span style="color: #000000">&size</span>,
+ .<span style="color: #000000">nodefault</span> <span style="color: #000000">=</span> <span style="color: #A90D91">true</span>
+ }
+ };
+ ...
+
+ <span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">json_read_object</span>(<span style="color: #000000">&njb->njb_buf</span>, <span style="color: #000000">off_attr</span>);
+ <span style="color: #A90D91">if</span> (<span style="color: #000000">rc</span> <span style="color: #000000">||</span> <span style="color: #000000">off</span> <span style="color: #000000">==</span> <span style="color: #000000">UINT_MAX</span>) {
+ <span style="color: #000000">rc</span> <span style="color: #000000">=</span> <span style="color: #000000">OS_EINVAL</span>;
+ <span style="color: #A90D91">goto</span> <span style="color: #000000">err</span>;
+ }
+ ...
+}
+</pre></div>
<div class="row">
@@ -653,16 +674,16 @@
<ul class="nav nav-pills" style="margin-bottom: 10px">
<li>
- <a href=../json_read_array/>
+ <a href=../json_encode_object_start/>
<span class="fa fa-arrow-left"></span>
- Previous: json_read_array
+ Previous: json_encode_object_start
</a>
</li>
<li class="pull-right">
- <a href=../json_target_address/>
- Next: json_target_address
+ <a href=../../stats/stats/>
+ Next: Stats
<span class="fa fa-arrow-right"></span>
</a>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/d4c7aea6/os/modules/json/json_target_address/index.html
----------------------------------------------------------------------
diff --git a/os/modules/json/json_target_address/index.html b/os/modules/json/json_target_address/index.html
deleted file mode 100644
index 38e3835..0000000
--- a/os/modules/json/json_target_address/index.html
+++ /dev/null
@@ -1,713 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <meta charset="utf-8">
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
-
-
- <link rel="canonical" href="http://mynewt.apache.org/os/modules/json/json_target_address/">
- <link rel="shortcut icon" href="../../../../img/favicon.ico">
-
- <title>json_target_address - Apache Mynewt</title>
-
- <link href="../../../../css/bootstrap-3.0.3.min.css" rel="stylesheet">
- <link href="../../../../css/font-awesome-4.0.3.css" rel="stylesheet">
- <link rel="stylesheet" href="../../../../css/highlight.css">
- <link href="../../../../css/base.css" rel="stylesheet">
- <link href="../../../../css/custom.css" rel="stylesheet">
- <link href='https://fonts.googleapis.com/css?family=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'>
- <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
- <link href="../../../../extra.css" rel="stylesheet">
-
- <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
- <!--[if lt IE 9]>
- <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
- <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
- <![endif]-->
-
-
- <script>
- (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
- (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
- m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
- })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
-
- ga('create', 'UA-72162311-1', 'mynewt.incubator.apache.org');
- ga('send', 'pageview');
- </script>
-
- </head>
-
-
- <body class="json_target_address">
-
-
- <div id="navbar" class="navbar navbar-default navbar-fixed-top" role="navigation">
- <div class="logo-container">
- <img src="/img/logo.svg">
- </div>
- <div class="container-fluid">
- <!-- Collapsed navigation -->
- <div class="navbar-header">
- <!-- Expander button -->
- <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
- <span class="sr-only">Toggle navigation</span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- </button>
-
- </div>
-
- <!-- Expanded navigation -->
- <div class="navbar-collapse collapse">
- <!-- Main navigation -->
- <ul class="nav navbar-nav navbar-right">
- <li>
- <a href="/">Home</a>
- </li>
- <li>
- <a href="/about/">About</a>
- </li>
- <li class="dropdown">
- <a href="/documentation/" class="dropdown-toggle" data-toggle="dropdown">Docs <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-
-
-
-
- <li >
- <a href="../../../../documentation/">
- Overview
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="active">
- <a href="../../../get_started/introduction/">
- Mynewt OS Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../../newt/newt_intro/">
- Newt Tool Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../../newtmgr/overview/">
- Newt Manager Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../tutorials/how_to_edit_docs/">
- Appendix
- </a>
- </li>
-
-
- </ul>
- </li>
- <li>
- <a href="/download/">Download</a>
- </li>
- <li>
- <a href="/community/">Community</a>
- </li>
- <li>
- <a href="/events/">Events</a>
- </li>
- </ul>
-
- <!-- Search, Navigation and Repo links -->
- <ul class="nav navbar-nav navbar-right">
-
- </ul>
- </div>
- </div>
-</div>
-
-
-
- <div class="container-fluid">
-
- <div class="row sm-extra-padding">
- <div id="docSidebar" class="col-md-3 bg-grey sidebar-container"><div class="bs-sidebar hidden-print" role="complementary">
- <div class="sidebar-top">
- <img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt">
- <div class="small" role="search">
- <form id ="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
- <div class="form-group">
- <input type="text" name="q" placeholder="Search documentation" />
- <button class="search-button" type="submit"><i class="fa fa-search"></i></button>
- </div>
- </form>
- </div>
- </div>
- <ul class="nav bs-sidenav">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li><a href="
- ../../../get_started/introduction/
-">Mynewt OS Manual</a>
-
-
- <ul class="current-toc">
-
-
-
-
- <li>
- <a href="../../../get_started/introduction/">Introduction</a>
- </li>
-
-
-
-
-
-
-
-
- <li ><a href="../../../get_started/get_started/">Quick Start</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../../get_started/vocabulary/">Concepts</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../../tutorials/tutorials/">Tutorials</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../../os_user_guide/">OS User Guide</a></li>
-
-
- <ul class="current-toc">
-
-
-
-
-
-
-
- <li ><a href="../../../core_os/mynewt_os/">OS Core</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../../core_os/porting/port_os/">Porting to your Platform</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../console/console/">Console</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../shell/shell/">Shell</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../bootloader/bootloader/">Bootloader</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li><a href="
-
-
- ../../fs/fs/fs/
-
-">File System</a>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../hal/hal/">Hardware Abstraction Layer</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../testutil/testutil/">Test Utilities</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../imgmgr/imgmgr/">Image Manager</a></li>
-
-
- </li>
-
-
-
-
-
-
- <li>
- <a href="../../baselibc/">Baselibc library</a>
- </li>
-
-
-
-
-
-
-
-
- <li ><a href="../../elua/elua/">Embedded Lua</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../json/">JSON</a></li>
-
-
- <ul class="current-toc">
-
-
-
-
-
-
-
- <li><a href="
- ../json_encode_object_entry/
-">Functions</a>
-
-
- <ul class="current-toc">
-
-
-
-
- <li>
- <a href="../json_encode_object_entry/">json_encode_object_entry</a>
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_encode_object_finish/">json_encode_object_finish</a>
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_encode_object_key/">json_encode_object_key</a>
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_encode_object_start/">json_encode_object_start</a>
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_encode_value/">json_encode_value</a>
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_internal_read_object/">json_internal_read_object</a>
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_read_array/">json_read_array</a>
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_read_object/">json_read_object</a>
- </li>
-
-
-
-
-
-
-
- <li class="active">
- json_target_address
- </li>
-
-
-
-
- </ul>
-
- </li>
-
-
-
- </ul>
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../stats/stats/">Stats</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../logs/logs/">Logs</a></li>
-
-
- </li>
-
-
-
- </ul>
-
- </li>
-
-
-
-
-
-
-
- <li><a href="
- ../../../../network/ble/ble_intro/
-">BLE User Guide</a>
-
-
- </li>
-
-
-
- </ul>
-
- </li>
-
-
-
-
-
-
-
- <li><a href="
- ../../../../newt/newt_intro/
-">Newt Tool Manual</a>
-
-
- </li>
-
-
-
-
-
-
-
- <li><a href="
- ../../../../newtmgr/overview/
-">Newt Manager Manual</a>
-
-
- </li>
-
-
-
-
-
-
-
- <li><a href="
- ../../../tutorials/how_to_edit_docs/
-">Appendix</a>
-
-
- </li>
-
-
-
- </ul>
-</div></div>
-
- <div class="show-sidebar-container">
- <button class="show-sidebar">Docs Menu</button>
- </div>
-
- <div class="col-md-offset-3 col-md-9 documentation-viewer" role="main">
- <div class="row doc-header">
- <div class="col-sm-6">
-
-<ul class="nav nav-pills">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="active" role="presentation"><a href="../../../get_started/introduction/">Mynewt OS</a></li>
-
-
-
- <li role="presentation"><a href="../../../../newt/newt_intro/">Newt Tool</a></li>
-
-
-
- <li role="presentation"><a href="../../../../newtmgr/overview/">Newt Mgr</a></li>
-
-
-
-
-</ul>
- </div>
- <div class="col-sm-6">
- <div role="navigation" aria-label="breadcrumbs navigation">
- <ul class="wy-breadcrumbs">
- <li><a href="/documentation/">Docs</a></li>
-
-
-
- <li>» <a href="../json/">JSON</a></li>
-
-
-
- <li>» <a href="../json_encode_object_entry/">Functions</a></li>
-
-
-
- <li>» json_target_address</li>
-
-
-
- </ul>
-</div>
- </div>
- </div>
-
-
-
- <div class="row">
-
-
-
-
-<ul class="nav nav-pills" style="margin-bottom: 10px">
- <li>
-
- <a href=../json_read_object/>
- <span class="fa fa-arrow-left"></span>
- Previous: json_read_object
- </a>
-
- </li>
- <li class="pull-right">
-
- <a href=../../stats/stats/>
- Next: Stats
- <span class="fa fa-arrow-right"></span>
- </a>
-
- </li>
-</ul>
- </div>
- <div class="row">
- <footer>
- <div class="row">
- <div class="col-md-12">
-
- <p class="copyright">Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0 Apache and the Apache feather logo are trademarks of The Apache Software Foundation.<br>The Apache Software Foundation Apache Incubator</p>
-
- </div>
- </div>
- <div class="copyright-logos">
- <div class="row">
- <div class="col-xs-6 text-right">
- <img src="/img/apache-feather.png" alt="Apache" title="Apache">
- </div>
- <div class="col-xs-6 text-left">
- <img src="/img/apache-logo.png" alt="Apache Incubator" title="Apache Incubator">
- </div>
- </div>
- </div>
- <div class="row">
- <div class="col-md-12">
- <small class="footnote">
- MyNewt is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
- </small>
- </div>
- </div>
-</footer>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <script src="../../../../js/jquery-1.10.2.min.js"></script>
- <script src="../../../../js/bootstrap-3.0.3.min.js"></script>
- <script src="../../../../js/highlight.pack.js"></script>
- <script src="../../../../js/base.js"></script>
- <script src="../../../../js/custom.js"></script>
-
- </body>
-</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/d4c7aea6/os/modules/stats/stats/index.html
----------------------------------------------------------------------
diff --git a/os/modules/stats/stats/index.html b/os/modules/stats/stats/index.html
index 588896f..8483655 100644
--- a/os/modules/stats/stats/index.html
+++ b/os/modules/stats/stats/index.html
@@ -813,9 +813,9 @@ not let two sections be entered with the same name.</p>
<ul class="nav nav-pills" style="margin-bottom: 10px">
<li>
- <a href=../../json/json_target_address/>
+ <a href=../../json/json_read_object/>
<span class="fa fa-arrow-left"></span>
- Previous: json_target_address
+ Previous: json_read_object
</a>
</li>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/d4c7aea6/sitemap.xml
----------------------------------------------------------------------
diff --git a/sitemap.xml b/sitemap.xml
index 481c644..86d7535 100644
--- a/sitemap.xml
+++ b/sitemap.xml
@@ -4,7 +4,7 @@
<url>
<loc>http://mynewt.apache.org/</loc>
- <lastmod>2016-05-06</lastmod>
+ <lastmod>2016-05-09</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -12,7 +12,7 @@
<url>
<loc>http://mynewt.apache.org/about/</loc>
- <lastmod>2016-05-06</lastmod>
+ <lastmod>2016-05-09</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -20,7 +20,7 @@
<url>
<loc>http://mynewt.apache.org/documentation/</loc>
- <lastmod>2016-05-06</lastmod>
+ <lastmod>2016-05-09</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -28,7 +28,7 @@
<url>
<loc>http://mynewt.apache.org/download/</loc>
- <lastmod>2016-05-06</lastmod>
+ <lastmod>2016-05-09</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -36,7 +36,7 @@
<url>
<loc>http://mynewt.apache.org/community/</loc>
- <lastmod>2016-05-06</lastmod>
+ <lastmod>2016-05-09</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -44,7 +44,7 @@
<url>
<loc>http://mynewt.apache.org/events/</loc>
- <lastmod>2016-05-06</lastmod>
+ <lastmod>2016-05-09</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -53,7 +53,7 @@
<url>
<loc>http://mynewt.apache.org/os/get_started/introduction/</loc>
- <lastmod>2016-05-06</lastmod>
+ <lastmod>2016-05-09</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -93,7 +93,7 @@
<url>
<loc>http://mynewt.apache.org/newt/newt_intro/</loc>
- <lastmod>2016-05-06</lastmod>
+ <lastmod>2016-05-09</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -105,7 +105,7 @@
<url>
<loc>http://mynewt.apache.org/newt/newt_operation/</loc>
- <lastmod>2016-05-06</lastmod>
+ <lastmod>2016-05-09</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -121,13 +121,13 @@
<url>
<loc>http://mynewt.apache.org/newtmgr/overview/</loc>
- <lastmod>2016-05-06</lastmod>
+ <lastmod>2016-05-09</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.apache.org/newtmgr/installing/</loc>
- <lastmod>2016-05-06</lastmod>
+ <lastmod>2016-05-09</lastmod>
<changefreq>daily</changefreq>
</url>
@@ -143,13 +143,13 @@
<url>
<loc>http://mynewt.apache.org/os/tutorials/how_to_edit_docs/</loc>
- <lastmod>2016-05-06</lastmod>
+ <lastmod>2016-05-09</lastmod>
<changefreq>daily</changefreq>
</url>
<url>
<loc>http://mynewt.apache.org/faq/answers/</loc>
- <lastmod>2016-05-06</lastmod>
+ <lastmod>2016-05-09</lastmod>
<changefreq>daily</changefreq>
</url>
[2/2] incubator-mynewt-site git commit: added json function call
descriptions - pull request #70 by Marko Kiiskila
Posted by ad...@apache.org.
added json function call descriptions - pull request #70 by Marko Kiiskila
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/d4c7aea6
Tree: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/tree/d4c7aea6
Diff: http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/diff/d4c7aea6
Branch: refs/heads/asf-site
Commit: d4c7aea620d6384d60bf9a6eb9a50792306864bc
Parents: 13287a3
Author: aditihilbert <ad...@runtime.io>
Authored: Mon May 9 13:33:41 2016 -0700
Committer: aditihilbert <ad...@runtime.io>
Committed: Mon May 9 13:33:41 2016 -0700
----------------------------------------------------------------------
mkdocs/search_index.json | 134 +++-
os/modules/json/json/index.html | 139 +++-
.../json/json_encode_object_entry/index.html | 88 +--
.../json/json_encode_object_finish/index.html | 80 +--
.../json/json_encode_object_key/index.html | 85 +--
.../json/json_encode_object_start/index.html | 84 ++-
os/modules/json/json_encode_value/index.html | 713 -------------------
.../json/json_internal_read_object/index.html | 713 -------------------
os/modules/json/json_read_array/index.html | 713 -------------------
os/modules/json/json_read_object/index.html | 111 +--
os/modules/json/json_target_address/index.html | 713 -------------------
os/modules/stats/stats/index.html | 4 +-
sitemap.xml | 26 +-
13 files changed, 492 insertions(+), 3111 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/d4c7aea6/mkdocs/search_index.json
----------------------------------------------------------------------
diff --git a/mkdocs/search_index.json b/mkdocs/search_index.json
index 388dbf4..9f99582 100644
--- a/mkdocs/search_index.json
+++ b/mkdocs/search_index.json
@@ -6072,73 +6072,163 @@
},
{
"location": "/os/modules/json/json/",
- "text": "JSON\n\n\nInsert synopsis here\n\n\nDescription\n\n\nDescribe module here, special features, how pieces fit together etc.\n\n\nData structures\n\n\nReplace this with the list of data structures used, why, any neat features\n\n\nList of Functions\n\n\n\n\nThe functions available in json are:\n\n\n\n\njson_encode_object_entry\n\n\njson_encode_object_finish\n\n\njson_encode_object_key\n\n\njson_encode_object_start\n\n\njson_encode_value\n\n\njson_internal_read_object\n\n\njson_read_array\n\n\njson_read_object\n\n\njson_target_address",
+ "text": "JSON\n\n\nJSON is a data interchange format. The description of this format can be found from IETF RFC 4627.\n\n\nDescription\n\n\nThis package helps in converting between C data types and JSON data objects. It supports both encoding and decoding.\n\n\nData structures\n\n\nEncoding\n\n\n/* Encoding functions */\n\n\ntypedef\n \nint\n (\n*\njson_write_func_t\n)(\nvoid\n \n*buf\n, \nchar\n \n*data\n,\n \nint\n \nlen\n);\n\n\nstruct\n \njson_encoder\n {\n \njson_write_func_t\n \nje_write\n;\n \nvoid\n \n*je_arg\n;\n \nint\n \nje_wr_commas\n:\n1\n;\n \nchar\n \nje_encode_buf\n[\n64\n];\n};\n\n\n\n\n\nHere's the data structure encoder funtions use, and it must be initialized by the caller. The key element is \nje_write\n, which is a function pointer which gets called whenever encoding routine is ready with encoded data. The element \nje_arg\n is passed to \nje_write\n as the first argument. The rest of the structure contents are for internal state
management.\nThis 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.\n\n\n/**\n\n\n * For encode. The contents of a JSON value to encode.\n\n\n */\n\n\nstruct\n \njson_value\n {\n \nuint8_t\n \njv_pad1\n;\n \nuint8_t\n \njv_type\n;\n \nuint16_t\n \njv_len\n;\n\n \nunion\n {\n \nuint64_t\n \nu\n;\n \nfloat\n \nfl\n;\n \nchar\n \n*str\n;\n \nstruct\n {\n \nchar\n \n**keys\n;\n \nstruct\n \njson_value\n \n**values\n;\n } \ncomposite\n;\n } \njv_val\n;\n};\n\n\n\n\n\nThis data structure is filled with data to be encoded. It is best to fill this using the macros \nJSON_VALUE_STRING()\n or \nJSON_VALUE_STRINGN()\n when value is string, \nJSON_VALUE_INT()\n when value is an integer, and so forth.\n\n\nDecoding\n\n\n/* when you implement a json buffer, you must implement these functions */\n\n\n\n/* returns the next characte
r in the buffer or \n\\0\n*/\n\n\ntypedef\n \nchar\n (\n*\njson_buffer_read_next_byte_t\n)(\nstruct\n \njson_buffer\n \n*\n);\n\n/* returns the previous character in the buffer or \n\\0\n */\n\n\ntypedef\n \nchar\n (\n*\njson_buffer_read_prev_byte_t\n)(\nstruct\n \njson_buffer\n \n*\n);\n\n/* returns the number of characters read or zero */\n\n\ntypedef\n \nint\n (\n*\njson_buffer_readn_t\n)(\nstruct\n \njson_buffer\n \n*\n, \nchar\n \n*buf\n, \nint\n \nn\n);\n\n\nstruct\n \njson_buffer\n {\n \njson_buffer_readn_t\n \njb_readn\n;\n \njson_buffer_read_next_byte_t\n \njb_read_next\n;\n \njson_buffer_read_prev_byte_t\n \njb_read_prev\n;\n};\n\n\n\n\n\nFunction pointers within this structure are used by decoder when it is reading in more data to decode.\n\n\nstruct\n \njson_attr_t\n {\n \nchar\n \n*attribute\n;\n \njson_type\n \ntype\n;\n \nunion\n {\n \nint\n \n*integer\n;\n \nunsigned\n \nint\n \n*uinteger\n;\n \ndouble\n \n*real\n;\n \nch
ar\n \n*string\n;\n \nbool\n \n*boolean\n;\n \nchar\n \n*character\n;\n \nstruct\n \njson_array_t\n \narray\n;\n \nsize_t\n \noffset\n;\n } \naddr\n;\n \nunion\n {\n \nint\n \ninteger\n;\n \nunsigned\n \nint\n \nuinteger\n;\n \ndouble\n \nreal\n;\n \nbool\n \nboolean\n;\n \nchar\n \ncharacter\n;\n \nchar\n \n*check\n;\n } \ndflt\n;\n \nsize_t\n \nlen\n;\n \nconst\n \nstruct\n \njson_enum_t\n \n*map\n;\n \nbool\n \nnodefault\n;\n};\n\n\n\n\n\nThis structure tells the decoder about a particular name/value pair. Structure must be filled in before calling the decoder routine \njson_read_object()\n.\n\n\n\n\n\n\n\n\nElement\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\nattribute\n\n\nName of the value\n\n\n\n\n\n\ntype\n\n\nThe type of the variable; see enum json_type\n\n\n\n\n\n\naddr\n\n\nContains the address where value should be stored\n\n\n\n\n\n\ndflt\n\n\nDefault value to fill in, if this name is not f
ound\n\n\n\n\n\n\nlen\n\n\nMax number of bytes to read in for value\n\n\n\n\n\n\nnodefault\n\n\nIf set, default value is not copied name\n\n\n\n\n\n\n\n\nList of Functions\n\n\nFunctions for encoding:\n\n\n\n\njson_encode_object_start\n\n\njson_encode_object_key\n\n\njson_encode_object_entry\n\n\njson_encode_object_finish\n\n\n\n\nFunctions for decoding:\n\n\n\n\njson_read_object",
"title": "toc"
},
{
"location": "/os/modules/json/json/#json",
- "text": "Insert synopsis here",
+ "text": "JSON is a data interchange format. The description of this format can be found from IETF RFC 4627.",
"title": "JSON"
},
{
"location": "/os/modules/json/json/#description",
- "text": "Describe module here, special features, how pieces fit together etc.",
+ "text": "This package helps in converting between C data types and JSON data objects. It supports both encoding and decoding.",
"title": "Description"
},
{
"location": "/os/modules/json/json/#data-structures",
- "text": "Replace this with the list of data structures used, why, any neat features",
+ "text": "",
"title": "Data structures"
},
{
+ "location": "/os/modules/json/json/#encoding",
+ "text": "/* Encoding functions */ typedef int ( * json_write_func_t )( void *buf , char *data ,\n int len ); struct json_encoder {\n json_write_func_t je_write ;\n void *je_arg ;\n int je_wr_commas : 1 ;\n char je_encode_buf [ 64 ];\n}; 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.\nThis 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. /** * For encode. The contents of a JSON value to encode. */ struct json_value {\n uint8_t jv_pad1 ;\n uint8_t jv_type ;\n uint16_t jv_len ;\n\n union {\n
uint64_t u ;\n float fl ;\n char *str ;\n struct {\n char **keys ;\n struct json_value **values ;\n } composite ;\n } jv_val ;\n}; 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.",
+ "title": "Encoding"
+ },
+ {
+ "location": "/os/modules/json/json/#decoding",
+ "text": "/* 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 {\n json_buffer_readn_t jb_readn ;\n json_buffer_read_next_byte_t jb_read_next ;\n json_buffer_read_prev_byte_t jb_read_prev ;\n}; Function pointers within this structure are used by decoder when it is reading in more data to decode. struct json_attr_t {\n char *attribute ;\n json_type type ;\n union {\n int *integer ;\n unsigned int *uinteger ;\n double *real ;\n char
*string ;\n bool *boolean ;\n char *character ;\n struct json_array_t array ;\n size_t offset ;\n } addr ;\n union {\n int integer ;\n unsigned int uinteger ;\n double real ;\n bool boolean ;\n char character ;\n char *check ;\n } dflt ;\n size_t len ;\n const struct json_enum_t *map ;\n bool nodefault ;\n}; This structure tells the decoder about a particular name/value pair. Structure must be filled in before calling the decoder routine json_read_object() . 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",
+ "title": "Decoding"
+ },
+ {
"location": "/os/modules/json/json/#list-of-functions",
- "text": "The functions available in json are: json_encode_object_entry json_encode_object_finish json_encode_object_key json_encode_object_start json_encode_value json_internal_read_object json_read_array json_read_object json_target_address",
+ "text": "Functions for encoding: json_encode_object_start json_encode_object_key json_encode_object_entry json_encode_object_finish Functions for decoding: json_read_object",
"title": "List of Functions"
},
{
"location": "/os/modules/json/json_encode_object_entry/",
- "text": "",
+ "text": "json_encode_object_entry \n\n\n int json_encode_object_entry(struct json_encoder *encoder, char *key, struct json_value *val)\n\n\n\n\n\nThis 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.\n\n\nArguments\n\n\n\n\n\n\n\n\nArguments\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\nencoder\n\n\njson_encoder to use\n\n\n\n\n\n\nkey\n\n\nname to write out\n\n\n\n\n\n\nval\n\n\nvalue to write out\n\n\n\n\n\n\n\n\nReturned values\n\n\n0 on success.\n\n\nExample\n\n\nstatic\n \nint\n\n\nimgr_list\n(\nstruct\n \nnmgr_jbuf\n \n*njb\n)\n{\n \nstruct\n \njson_encoder\n \n*enc\n;\n \nstruct\n \njson_value\n \narray\n;\n\n ...\n\n \njson_encode_object_start\n(\nenc\n);\n \njson_encode_object_entry\n(\nenc\n, \nimages\n, \narray\n);\n \njson_encode_object_finish\n(\nenc\n);\n\n \nreturn\n \n0\n;\n}",
"title": "json_encode_object_entry"
},
{
+ "location": "/os/modules/json/json_encode_object_entry/#json_encode_object_entry",
+ "text": "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.",
+ "title": " json_encode_object_entry "
+ },
+ {
+ "location": "/os/modules/json/json_encode_object_entry/#arguments",
+ "text": "Arguments Description encoder json_encoder to use key name to write out val value to write out",
+ "title": "Arguments"
+ },
+ {
+ "location": "/os/modules/json/json_encode_object_entry/#returned-values",
+ "text": "0 on success.",
+ "title": "Returned values"
+ },
+ {
+ "location": "/os/modules/json/json_encode_object_entry/#example",
+ "text": "static int imgr_list ( struct nmgr_jbuf *njb )\n{\n struct json_encoder *enc ;\n struct json_value array ;\n\n ...\n\n json_encode_object_start ( enc );\n json_encode_object_entry ( enc , images , array );\n json_encode_object_finish ( enc );\n\n return 0 ;\n}",
+ "title": "Example"
+ },
+ {
"location": "/os/modules/json/json_encode_object_finish/",
- "text": "",
+ "text": "json_encode_object_finish \n\n\n int json_encode_object_finish(struct json_encoder *encoder)\n\n\n\n\n\nThis function finalizes the encoded JSON object. This means writing out the last \"}\" character.\n\n\nArguments\n\n\n\n\n\n\n\n\nArguments\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\nencoder\n\n\njson_encoder to use\n\n\n\n\n\n\n\n\nReturned values\n\n\n0 on success.\n\n\nExample\n\n\nstatic\n \nint\n\n\nimgr_list\n(\nstruct\n \nnmgr_jbuf\n \n*njb\n)\n{\n \nstruct\n \njson_encoder\n \n*enc\n;\n \nstruct\n \njson_value\n \narray\n;\n\n ...\n\n \njson_encode_object_start\n(\nenc\n);\n \njson_encode_object_entry\n(\nenc\n, \nimages\n, \narray\n);\n \njson_encode_object_finish\n(\nenc\n);\n\n \nreturn\n \n0\n;\n}",
"title": "json_encode_object_finish"
},
{
+ "location": "/os/modules/json/json_encode_object_finish/#json_encode_object_finish",
+ "text": "int json_encode_object_finish(struct json_encoder *encoder) This function finalizes the encoded JSON object. This means writing out the last \"}\" character.",
+ "title": " json_encode_object_finish "
+ },
+ {
+ "location": "/os/modules/json/json_encode_object_finish/#arguments",
+ "text": "Arguments Description encoder json_encoder to use",
+ "title": "Arguments"
+ },
+ {
+ "location": "/os/modules/json/json_encode_object_finish/#returned-values",
+ "text": "0 on success.",
+ "title": "Returned values"
+ },
+ {
+ "location": "/os/modules/json/json_encode_object_finish/#example",
+ "text": "static int imgr_list ( struct nmgr_jbuf *njb )\n{\n struct json_encoder *enc ;\n struct json_value array ;\n\n ...\n\n json_encode_object_start ( enc );\n json_encode_object_entry ( enc , images , array );\n json_encode_object_finish ( enc );\n\n return 0 ;\n}",
+ "title": "Example"
+ },
+ {
"location": "/os/modules/json/json_encode_object_key/",
- "text": "",
+ "text": "json_encode_object_key \n\n\n int json_encode_object_key(struct json_encoder *encoder, char *key)\n\n\n\n\n\nThis 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.\n\n\nArguments\n\n\n\n\n\n\n\n\nArguments\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\nencoder\n\n\njson_encoder to use\n\n\n\n\n\n\nkey\n\n\nname to write out\n\n\n\n\n\n\n\n\nReturned values\n\n\n0 on success.\n\n\nExample\n\n\nint\n\n\nnmgr_def_taskstat_read\n(\nstruct\n \nnmgr_jbuf\n \n*njb\n)\n{\n ...\n\n \nstruct\n \njson_value\n \njv\n;\n\n \njson_encode_object_start\n(\nnjb-\nnjb_enc\n);\n \nJSON_VALUE_INT\n(\njv\n, \nNMGR_ERR_EOK\n);\n \njson_encode_object_entry\n(\nnjb-\nnjb_enc\n, \nrc\n, \njv\n);\n\n \njson_encode_object_key\n(\nnjb-\nnjb_enc\n, \ntasks\n);\n \njson_encode_object_start\n(\nnjb-\nnjb_enc\n);\n ...\n}",
"title": "json_encode_object_key"
},
{
+ "location": "/os/modules/json/json_encode_object_key/#json_encode_object_key",
+ "text": "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.",
+ "title": " json_encode_object_key "
+ },
+ {
+ "location": "/os/modules/json/json_encode_object_key/#arguments",
+ "text": "Arguments Description encoder json_encoder to use key name to write out",
+ "title": "Arguments"
+ },
+ {
+ "location": "/os/modules/json/json_encode_object_key/#returned-values",
+ "text": "0 on success.",
+ "title": "Returned values"
+ },
+ {
+ "location": "/os/modules/json/json_encode_object_key/#example",
+ "text": "int nmgr_def_taskstat_read ( struct nmgr_jbuf *njb )\n{\n ...\n\n struct json_value jv ;\n\n json_encode_object_start ( njb- njb_enc );\n JSON_VALUE_INT ( jv , NMGR_ERR_EOK );\n json_encode_object_entry ( njb- njb_enc , rc , jv );\n\n json_encode_object_key ( njb- njb_enc , tasks );\n json_encode_object_start ( njb- njb_enc );\n ...\n}",
+ "title": "Example"
+ },
+ {
"location": "/os/modules/json/json_encode_object_start/",
- "text": "",
+ "text": "json_encode_object_start \n\n\n int json_encode_object_start(struct json_encoder *encoder)\n\n\n\n\n\nThis function starts the encoded JSON object. Usually this means writing out the initial \"{\" character.\n\n\nArguments\n\n\n\n\n\n\n\n\nArguments\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\nencoder\n\n\njson_encoder to use\n\n\n\n\n\n\n\n\nReturned values\n\n\n0 on success.\n\n\nExample\n\n\nstatic\n \nint\n\n\nimgr_list\n(\nstruct\n \nnmgr_jbuf\n \n*njb\n)\n{\n \nstruct\n \njson_encoder\n \n*enc\n;\n \nstruct\n \njson_value\n \narray\n;\n\n ...\n\n \njson_encode_object_start\n(\nenc\n);\n \njson_encode_object_entry\n(\nenc\n, \nimages\n, \narray\n);\n \njson_encode_object_finish\n(\nenc\n);\n\n \nreturn\n \n0\n;\n}",
"title": "json_encode_object_start"
},
{
- "location": "/os/modules/json/json_encode_value/",
- "text": "",
- "title": "json_encode_value"
+ "location": "/os/modules/json/json_encode_object_start/#json_encode_object_start",
+ "text": "int json_encode_object_start(struct json_encoder *encoder) This function starts the encoded JSON object. Usually this means writing out the initial \"{\" character.",
+ "title": " json_encode_object_start "
},
{
- "location": "/os/modules/json/json_internal_read_object/",
- "text": "",
- "title": "json_internal_read_object"
+ "location": "/os/modules/json/json_encode_object_start/#arguments",
+ "text": "Arguments Description encoder json_encoder to use",
+ "title": "Arguments"
},
{
- "location": "/os/modules/json/json_read_array/",
- "text": "",
- "title": "json_read_array"
+ "location": "/os/modules/json/json_encode_object_start/#returned-values",
+ "text": "0 on success.",
+ "title": "Returned values"
+ },
+ {
+ "location": "/os/modules/json/json_encode_object_start/#example",
+ "text": "static int imgr_list ( struct nmgr_jbuf *njb )\n{\n struct json_encoder *enc ;\n struct json_value array ;\n\n ...\n\n json_encode_object_start ( enc );\n json_encode_object_entry ( enc , images , array );\n json_encode_object_finish ( enc );\n\n return 0 ;\n}",
+ "title": "Example"
},
{
"location": "/os/modules/json/json_read_object/",
- "text": "",
+ "text": "json_read_object \n\n\n int json_read_object(struct json_buffer *jb, const struct json_attr_t *attrs)\n\n\n\n\n\nThis function reads in JSON data stream, while looking for name/value pairs described in \nattrs\n. \nattrs\n is an array; end of the array is indicated by an entry with \nNULL\n as the name.\n\n\nArguments\n\n\n\n\n\n\n\n\nArguments\n\n\nDescription\n\n\n\n\n\n\n\n\n\n\njb\n\n\njson_decoder to use\n\n\n\n\n\n\nattrs\n\n\narray of attributes to look for\n\n\n\n\n\n\n\n\nReturned values\n\n\n0 on success.\n\n\nExample\n\n\nstatic\n \nint\n\n\nimgr_upload\n(\nstruct\n \nnmgr_jbuf\n \n*njb\n)\n{\n ...\n \nconst\n \nstruct\n \njson_attr_t\n \noff_attr\n[\n4\n] \n=\n {\n [\n0\n] \n=\n {\n .\nattribute\n \n=\n \noff\n,\n .\ntype\n \n=\n \nt_uinteger\n,\n .\naddr\n.\nuinteger\n \n=\n \noff\n,\n .\nnodefault\n \n=\n \ntrue\n\n },\n [\n1\n] \n=\n {\n .\nattribute\n \n=\n \ndata
\n,\n .\ntype\n \n=\n \nt_string\n,\n .\naddr\n.\nstring\n \n=\n \nimg_data\n,\n .\nlen\n \n=\n \nsizeof\n(\nimg_data\n)\n },\n [\n2\n] \n=\n {\n .\nattribute\n \n=\n \nlen\n,\n .\ntype\n \n=\n \nt_uinteger\n,\n .\naddr\n.\nuinteger\n \n=\n \nsize\n,\n .\nnodefault\n \n=\n \ntrue\n\n }\n };\n ...\n\n \nrc\n \n=\n \njson_read_object\n(\nnjb-\nnjb_buf\n, \noff_attr\n);\n \nif\n (\nrc\n \n||\n \noff\n \n==\n \nUINT_MAX\n) {\n \nrc\n \n=\n \nOS_EINVAL\n;\n \ngoto\n \nerr\n;\n }\n ...\n}",
"title": "json_read_object"
},
{
- "location": "/os/modules/json/json_target_address/",
- "text": "",
- "title": "json_target_address"
+ "location": "/os/modules/json/json_read_object/#json_read_object",
+ "text": "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.",
+ "title": " json_read_object "
+ },
+ {
+ "location": "/os/modules/json/json_read_object/#arguments",
+ "text": "Arguments Description jb json_decoder to use attrs array of attributes to look for",
+ "title": "Arguments"
+ },
+ {
+ "location": "/os/modules/json/json_read_object/#returned-values",
+ "text": "0 on success.",
+ "title": "Returned values"
+ },
+ {
+ "location": "/os/modules/json/json_read_object/#example",
+ "text": "static int imgr_upload ( struct nmgr_jbuf *njb )\n{\n ...\n const struct json_attr_t off_attr [ 4 ] = {\n [ 0 ] = {\n . attribute = off ,\n . type = t_uinteger ,\n . addr . uinteger = off ,\n . nodefault = true \n },\n [ 1 ] = {\n . attribute = data ,\n . type = t_string ,\n . addr . string = img_data ,\n . len = sizeof ( img_data )\n },\n [ 2 ] = {\n . attribute = len ,\n . type = t_uinteger ,\n . addr . uinteger = size ,\n . nodefault = true \n }\n };\n ...\n\n rc = json_read_object ( njb- njb_buf , off_attr );\n if ( rc || off == UINT_MAX ) {\n rc = OS_EINVAL ;\n goto err ;\n }\n ...\n}",
+ "title": "Example"
},
{
"location": "/os/modules/stats/stats/",
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/d4c7aea6/os/modules/json/json/index.html
----------------------------------------------------------------------
diff --git a/os/modules/json/json/index.html b/os/modules/json/json/index.html
index abbd060..567f97e 100644
--- a/os/modules/json/json/index.html
+++ b/os/modules/json/json/index.html
@@ -548,24 +548,141 @@
</div>
<h1 id="json">JSON<a class="headerlink" href="#json" title="Permanent link">¶</a></h1>
-<p>Insert synopsis here</p>
+<p>JSON is a data interchange format. The description of this format can be found from IETF RFC 4627.</p>
<h2 id="description">Description<a class="headerlink" href="#description" title="Permanent link">¶</a></h2>
-<p>Describe module here, special features, how pieces fit together etc.</p>
+<p>This package helps in converting between C data types and JSON data objects. It supports both encoding and decoding.</p>
<h2 id="data-structures">Data structures<a class="headerlink" href="#data-structures" title="Permanent link">¶</a></h2>
-<p>Replace this with the list of data structures used, why, any neat features</p>
+<h3 id="encoding">Encoding<a class="headerlink" href="#encoding" title="Permanent link">¶</a></h3>
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #177500">/* Encoding functions */</span>
+<span style="color: #A90D91">typedef</span> <span style="color: #000000">int</span> (<span style="color: #000000">*</span><span style="color: #A90D91">json_write_func_t</span>)(<span style="color: #A90D91">void</span> <span style="color: #000000">*buf</span>, <span style="color: #A90D91">char</span> <span style="color: #000000">*data</span>,
+ <span style="color: #A90D91">int</span> <span style="color: #000000">len</span>);
+
+<span style="color: #A90D91">struct</span> <span style="color: #000000">json_encoder</span> {
+ <span style="color: #A90D91">json_write_func_t</span> <span style="color: #000000">je_write</span>;
+ <span style="color: #A90D91">void</span> <span style="color: #000000">*je_arg</span>;
+ <span style="color: #A90D91">int</span> <span style="color: #000000">je_wr_commas</span>:<span style="color: #1C01CE">1</span>;
+ <span style="color: #A90D91">char</span> <span style="color: #000000">je_encode_buf</span>[<span style="color: #1C01CE">64</span>];
+};
+</pre></div>
+
+
+<p>Here's the data structure encoder funtions use, and it must be initialized by the caller. The key element is <em>je_write</em>, which is a function pointer which gets called whenever encoding routine is ready with encoded data. The element <em>je_arg</em> is passed to <em>je_write</em> 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.</p>
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #177500">/**</span>
+<span style="color: #177500"> * For encode. The contents of a JSON value to encode.</span>
+<span style="color: #177500"> */</span>
+<span style="color: #A90D91">struct</span> <span style="color: #000000">json_value</span> {
+ <span style="color: #A90D91">uint8_t</span> <span style="color: #000000">jv_pad1</span>;
+ <span style="color: #A90D91">uint8_t</span> <span style="color: #000000">jv_type</span>;
+ <span style="color: #A90D91">uint16_t</span> <span style="color: #000000">jv_len</span>;
+
+ <span style="color: #A90D91">union</span> {
+ <span style="color: #A90D91">uint64_t</span> <span style="color: #000000">u</span>;
+ <span style="color: #A90D91">float</span> <span style="color: #000000">fl</span>;
+ <span style="color: #A90D91">char</span> <span style="color: #000000">*str</span>;
+ <span style="color: #A90D91">struct</span> {
+ <span style="color: #A90D91">char</span> <span style="color: #000000">**keys</span>;
+ <span style="color: #A90D91">struct</span> <span style="color: #000000">json_value</span> <span style="color: #000000">**values</span>;
+ } <span style="color: #000000">composite</span>;
+ } <span style="color: #000000">jv_val</span>;
+};
+</pre></div>
+
+
+<p>This data structure is filled with data to be encoded. It is best to fill this using the macros <em>JSON_VALUE_STRING()</em> or <em>JSON_VALUE_STRINGN()</em> when value is string, <em>JSON_VALUE_INT()</em> when value is an integer, and so forth.</p>
+<h3 id="decoding">Decoding<a class="headerlink" href="#decoding" title="Permanent link">¶</a></h3>
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #177500">/* when you implement a json buffer, you must implement these functions */</span>
+
+<span style="color: #177500">/* returns the next character in the buffer or '\0'*/</span>
+<span style="color: #A90D91">typedef</span> <span style="color: #000000">char</span> (<span style="color: #000000">*</span><span style="color: #A90D91">json_buffer_read_next_byte_t</span>)(<span style="color: #A90D91">struct</span> <span style="color: #000000">json_buffer</span> <span style="color: #000000">*</span>);
+<span style="color: #177500">/* returns the previous character in the buffer or '\0' */</span>
+<span style="color: #A90D91">typedef</span> <span style="color: #000000">char</span> (<span style="color: #000000">*</span><span style="color: #A90D91">json_buffer_read_prev_byte_t</span>)(<span style="color: #A90D91">struct</span> <span style="color: #000000">json_buffer</span> <span style="color: #000000">*</span>);
+<span style="color: #177500">/* returns the number of characters read or zero */</span>
+<span style="color: #A90D91">typedef</span> <span style="color: #000000">int</span> (<span style="color: #000000">*</span><span style="color: #A90D91">json_buffer_readn_t</span>)(<span style="color: #A90D91">struct</span> <span style="color: #000000">json_buffer</span> <span style="color: #000000">*</span>, <span style="color: #A90D91">char</span> <span style="color: #000000">*buf</span>, <span style="color: #A90D91">int</span> <span style="color: #000000">n</span>);
+
+<span style="color: #A90D91">struct</span> <span style="color: #000000">json_buffer</span> {
+ <span style="color: #A90D91">json_buffer_readn_t</span> <span style="color: #000000">jb_readn</span>;
+ <span style="color: #A90D91">json_buffer_read_next_byte_t</span> <span style="color: #000000">jb_read_next</span>;
+ <span style="color: #A90D91">json_buffer_read_prev_byte_t</span> <span style="color: #000000">jb_read_prev</span>;
+};
+</pre></div>
+
+
+<p>Function pointers within this structure are used by decoder when it is reading in more data to decode.</p>
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">struct</span> <span style="color: #A90D91">json_attr_t</span> {
+ <span style="color: #A90D91">char</span> <span style="color: #000000">*attribute</span>;
+ <span style="color: #000000">json_type</span> <span style="color: #000000">type</span>;
+ <span style="color: #A90D91">union</span> {
+ <span style="color: #A90D91">int</span> <span style="color: #000000">*integer</span>;
+ <span style="color: #A90D91">unsigned</span> <span style="color: #A90D91">int</span> <span style="color: #000000">*uinteger</span>;
+ <span style="color: #A90D91">double</span> <span style="color: #000000">*real</span>;
+ <span style="color: #A90D91">char</span> <span style="color: #000000">*string</span>;
+ <span style="color: #A90D91">bool</span> <span style="color: #000000">*boolean</span>;
+ <span style="color: #A90D91">char</span> <span style="color: #000000">*character</span>;
+ <span style="color: #A90D91">struct</span> <span style="color: #A90D91">json_array_t</span> <span style="color: #000000">array</span>;
+ <span style="color: #A90D91">size_t</span> <span style="color: #000000">offset</span>;
+ } <span style="color: #000000">addr</span>;
+ <span style="color: #A90D91">union</span> {
+ <span style="color: #A90D91">int</span> <span style="color: #000000">integer</span>;
+ <span style="color: #A90D91">unsigned</span> <span style="color: #A90D91">int</span> <span style="color: #000000">uinteger</span>;
+ <span style="color: #A90D91">double</span> <span style="color: #000000">real</span>;
+ <span style="color: #A90D91">bool</span> <span style="color: #000000">boolean</span>;
+ <span style="color: #A90D91">char</span> <span style="color: #000000">character</span>;
+ <span style="color: #A90D91">char</span> <span style="color: #000000">*check</span>;
+ } <span style="color: #000000">dflt</span>;
+ <span style="color: #A90D91">size_t</span> <span style="color: #000000">len</span>;
+ <span style="color: #A90D91">const</span> <span style="color: #A90D91">struct</span> <span style="color: #A90D91">json_enum_t</span> <span style="color: #000000">*map</span>;
+ <span style="color: #A90D91">bool</span> <span style="color: #000000">nodefault</span>;
+};
+</pre></div>
+
+
+<p>This structure tells the decoder about a particular name/value pair. Structure must be filled in before calling the decoder routine <em>json_read_object()</em>.</p>
+<table>
+<thead>
+<tr>
+<th>Element</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>attribute</td>
+<td>Name of the value</td>
+</tr>
+<tr>
+<td>type</td>
+<td>The type of the variable; see enum json_type</td>
+</tr>
+<tr>
+<td>addr</td>
+<td>Contains the address where value should be stored</td>
+</tr>
+<tr>
+<td>dflt</td>
+<td>Default value to fill in, if this name is not found</td>
+</tr>
+<tr>
+<td>len</td>
+<td>Max number of bytes to read in for value</td>
+</tr>
+<tr>
+<td>nodefault</td>
+<td>If set, default value is not copied name</td>
+</tr>
+</tbody>
+</table>
<h2 id="list-of-functions">List of Functions<a class="headerlink" href="#list-of-functions" title="Permanent link">¶</a></h2>
-<p><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.></p>
-<p>The functions available in json are:</p>
+<p>Functions for encoding:</p>
<ul>
+<li><a href="../json_encode_object_start/">json_encode_object_start</a></li>
+<li><a href="../json_encode_object_key/">json_encode_object_key</a></li>
<li><a href="../json_encode_object_entry/">json_encode_object_entry</a></li>
<li><a href="../json_encode_object_finish/">json_encode_object_finish</a></li>
-<li><a href="../json_encode_object_key/">json_encode_object_key</a></li>
-<li><a href="../json_encode_object_start/">json_encode_object_start</a></li>
-<li><a href="../json_encode_value/">json_encode_value</a></li>
-<li><a href="../json_internal_read_object/">json_internal_read_object</a></li>
-<li><a href="../json_read_array/">json_read_array</a></li>
+</ul>
+<p>Functions for decoding:</p>
+<ul>
<li><a href="../json_read_object/">json_read_object</a></li>
-<li><a href="../json_target_address/">json_target_address</a></li>
</ul>
<div class="row">
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/d4c7aea6/os/modules/json/json_encode_object_entry/index.html
----------------------------------------------------------------------
diff --git a/os/modules/json/json_encode_object_entry/index.html b/os/modules/json/json_encode_object_entry/index.html
index 5b944ab..f7cb25a 100644
--- a/os/modules/json/json_encode_object_entry/index.html
+++ b/os/modules/json/json_encode_object_entry/index.html
@@ -432,52 +432,12 @@
<li>
- <a href="../json_encode_value/">json_encode_value</a>
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_internal_read_object/">json_internal_read_object</a>
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_read_array/">json_read_array</a>
- </li>
-
-
-
-
-
-
-
- <li>
<a href="../json_read_object/">json_read_object</a>
</li>
-
-
-
- <li>
- <a href="../json_target_address/">json_target_address</a>
- </li>
-
-
-
-
</ul>
</li>
@@ -643,7 +603,53 @@
</div>
</div>
-
+ <h2 id="json_encode_object_entry"><font color="#F2853F" style="font-size:24pt"> json_encode_object_entry </font><a class="headerlink" href="#json_encode_object_entry" title="Permanent link">¶</a></h2>
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> int json_encode_object_entry(struct json_encoder *encoder, char *key, struct json_value *val)
+</pre></div>
+
+
+<p>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.</p>
+<h4 id="arguments">Arguments<a class="headerlink" href="#arguments" title="Permanent link">¶</a></h4>
+<table>
+<thead>
+<tr>
+<th>Arguments</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>encoder</td>
+<td>json_encoder to use</td>
+</tr>
+<tr>
+<td>key</td>
+<td>name to write out</td>
+</tr>
+<tr>
+<td>val</td>
+<td>value to write out</td>
+</tr>
+</tbody>
+</table>
+<h4 id="returned-values">Returned values<a class="headerlink" href="#returned-values" title="Permanent link">¶</a></h4>
+<p>0 on success.</p>
+<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">static</span> <span style="color: #A90D91">int</span>
+<span style="color: #000000">imgr_list</span>(<span style="color: #A90D91">struct</span> <span style="color: #000000">nmgr_jbuf</span> <span style="color: #000000">*njb</span>)
+{
+ <span style="color: #A90D91">struct</span> <span style="color: #000000">json_encoder</span> <span style="color: #000000">*enc</span>;
+ <span style="color: #A90D91">struct</span> <span style="color: #000000">json_value</span> <span style="color: #000000">array</span>;
+
+ ...
+
+ <span style="color: #000000">json_encode_object_start</span>(<span style="color: #000000">enc</span>);
+ <span style="color: #000000">json_encode_object_entry</span>(<span style="color: #000000">enc</span>, <span style="color: #C41A16">"images"</span>, <span style="color: #000000">&array</span>);
+ <span style="color: #000000">json_encode_object_finish</span>(<span style="color: #000000">enc</span>);
+
+ <span style="color: #A90D91">return</span> <span style="color: #1C01CE">0</span>;
+}
+</pre></div>
<div class="row">
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/d4c7aea6/os/modules/json/json_encode_object_finish/index.html
----------------------------------------------------------------------
diff --git a/os/modules/json/json_encode_object_finish/index.html b/os/modules/json/json_encode_object_finish/index.html
index d92ae1d..1997e2d 100644
--- a/os/modules/json/json_encode_object_finish/index.html
+++ b/os/modules/json/json_encode_object_finish/index.html
@@ -432,52 +432,12 @@
<li>
- <a href="../json_encode_value/">json_encode_value</a>
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_internal_read_object/">json_internal_read_object</a>
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_read_array/">json_read_array</a>
- </li>
-
-
-
-
-
-
-
- <li>
<a href="../json_read_object/">json_read_object</a>
</li>
-
-
-
- <li>
- <a href="../json_target_address/">json_target_address</a>
- </li>
-
-
-
-
</ul>
</li>
@@ -643,7 +603,45 @@
</div>
</div>
-
+ <h2 id="json_encode_object_finish"><font color="#F2853F" style="font-size:24pt"> json_encode_object_finish </font><a class="headerlink" href="#json_encode_object_finish" title="Permanent link">¶</a></h2>
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> int json_encode_object_finish(struct json_encoder *encoder)
+</pre></div>
+
+
+<p>This function finalizes the encoded JSON object. This means writing out the last "}" character.</p>
+<h4 id="arguments">Arguments<a class="headerlink" href="#arguments" title="Permanent link">¶</a></h4>
+<table>
+<thead>
+<tr>
+<th>Arguments</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>encoder</td>
+<td>json_encoder to use</td>
+</tr>
+</tbody>
+</table>
+<h4 id="returned-values">Returned values<a class="headerlink" href="#returned-values" title="Permanent link">¶</a></h4>
+<p>0 on success.</p>
+<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">static</span> <span style="color: #A90D91">int</span>
+<span style="color: #000000">imgr_list</span>(<span style="color: #A90D91">struct</span> <span style="color: #000000">nmgr_jbuf</span> <span style="color: #000000">*njb</span>)
+{
+ <span style="color: #A90D91">struct</span> <span style="color: #000000">json_encoder</span> <span style="color: #000000">*enc</span>;
+ <span style="color: #A90D91">struct</span> <span style="color: #000000">json_value</span> <span style="color: #000000">array</span>;
+
+ ...
+
+ <span style="color: #000000">json_encode_object_start</span>(<span style="color: #000000">enc</span>);
+ <span style="color: #000000">json_encode_object_entry</span>(<span style="color: #000000">enc</span>, <span style="color: #C41A16">"images"</span>, <span style="color: #000000">&array</span>);
+ <span style="color: #000000">json_encode_object_finish</span>(<span style="color: #000000">enc</span>);
+
+ <span style="color: #A90D91">return</span> <span style="color: #1C01CE">0</span>;
+}
+</pre></div>
<div class="row">
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/d4c7aea6/os/modules/json/json_encode_object_key/index.html
----------------------------------------------------------------------
diff --git a/os/modules/json/json_encode_object_key/index.html b/os/modules/json/json_encode_object_key/index.html
index 230b543..4bee692 100644
--- a/os/modules/json/json_encode_object_key/index.html
+++ b/os/modules/json/json_encode_object_key/index.html
@@ -432,52 +432,12 @@
<li>
- <a href="../json_encode_value/">json_encode_value</a>
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_internal_read_object/">json_internal_read_object</a>
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_read_array/">json_read_array</a>
- </li>
-
-
-
-
-
-
-
- <li>
<a href="../json_read_object/">json_read_object</a>
</li>
-
-
-
- <li>
- <a href="../json_target_address/">json_target_address</a>
- </li>
-
-
-
-
</ul>
</li>
@@ -643,7 +603,50 @@
</div>
</div>
-
+ <h2 id="json_encode_object_key"><font color="#F2853F" style="font-size:24pt"> json_encode_object_key </font><a class="headerlink" href="#json_encode_object_key" title="Permanent link">¶</a></h2>
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> int json_encode_object_key(struct json_encoder *encoder, char *key)
+</pre></div>
+
+
+<p>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.</p>
+<h4 id="arguments">Arguments<a class="headerlink" href="#arguments" title="Permanent link">¶</a></h4>
+<table>
+<thead>
+<tr>
+<th>Arguments</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>encoder</td>
+<td>json_encoder to use</td>
+</tr>
+<tr>
+<td>key</td>
+<td>name to write out</td>
+</tr>
+</tbody>
+</table>
+<h4 id="returned-values">Returned values<a class="headerlink" href="#returned-values" title="Permanent link">¶</a></h4>
+<p>0 on success.</p>
+<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">int</span>
+<span style="color: #000000">nmgr_def_taskstat_read</span>(<span style="color: #A90D91">struct</span> <span style="color: #000000">nmgr_jbuf</span> <span style="color: #000000">*njb</span>)
+{
+ ...
+
+ <span style="color: #A90D91">struct</span> <span style="color: #000000">json_value</span> <span style="color: #000000">jv</span>;
+
+ <span style="color: #000000">json_encode_object_start</span>(<span style="color: #000000">&njb->njb_enc</span>);
+ <span style="color: #000000">JSON_VALUE_INT</span>(<span style="color: #000000">&jv</span>, <span style="color: #000000">NMGR_ERR_EOK</span>);
+ <span style="color: #000000">json_encode_object_entry</span>(<span style="color: #000000">&njb->njb_enc</span>, <span style="color: #C41A16">"rc"</span>, <span style="color: #000000">&jv</span>);
+
+ <span style="color: #000000">json_encode_object_key</span>(<span style="color: #000000">&njb->njb_enc</span>, <span style="color: #C41A16">"tasks"</span>);
+ <span style="color: #000000">json_encode_object_start</span>(<span style="color: #000000">&njb->njb_enc</span>);
+ ...
+}
+</pre></div>
<div class="row">
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/d4c7aea6/os/modules/json/json_encode_object_start/index.html
----------------------------------------------------------------------
diff --git a/os/modules/json/json_encode_object_start/index.html b/os/modules/json/json_encode_object_start/index.html
index c112c6d..45b3459 100644
--- a/os/modules/json/json_encode_object_start/index.html
+++ b/os/modules/json/json_encode_object_start/index.html
@@ -432,52 +432,12 @@
<li>
- <a href="../json_encode_value/">json_encode_value</a>
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_internal_read_object/">json_internal_read_object</a>
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_read_array/">json_read_array</a>
- </li>
-
-
-
-
-
-
-
- <li>
<a href="../json_read_object/">json_read_object</a>
</li>
-
-
-
- <li>
- <a href="../json_target_address/">json_target_address</a>
- </li>
-
-
-
-
</ul>
</li>
@@ -643,7 +603,45 @@
</div>
</div>
-
+ <h2 id="json_encode_object_start"><font color="#F2853F" style="font-size:24pt"> json_encode_object_start </font><a class="headerlink" href="#json_encode_object_start" title="Permanent link">¶</a></h2>
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"> int json_encode_object_start(struct json_encoder *encoder)
+</pre></div>
+
+
+<p>This function starts the encoded JSON object. Usually this means writing out the initial "{" character.</p>
+<h4 id="arguments">Arguments<a class="headerlink" href="#arguments" title="Permanent link">¶</a></h4>
+<table>
+<thead>
+<tr>
+<th>Arguments</th>
+<th>Description</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>encoder</td>
+<td>json_encoder to use</td>
+</tr>
+</tbody>
+</table>
+<h4 id="returned-values">Returned values<a class="headerlink" href="#returned-values" title="Permanent link">¶</a></h4>
+<p>0 on success.</p>
+<h4 id="example">Example<a class="headerlink" href="#example" title="Permanent link">¶</a></h4>
+<div class="codehilite" style="background: #ffffff"><pre style="line-height: 125%"><span style="color: #A90D91">static</span> <span style="color: #A90D91">int</span>
+<span style="color: #000000">imgr_list</span>(<span style="color: #A90D91">struct</span> <span style="color: #000000">nmgr_jbuf</span> <span style="color: #000000">*njb</span>)
+{
+ <span style="color: #A90D91">struct</span> <span style="color: #000000">json_encoder</span> <span style="color: #000000">*enc</span>;
+ <span style="color: #A90D91">struct</span> <span style="color: #000000">json_value</span> <span style="color: #000000">array</span>;
+
+ ...
+
+ <span style="color: #000000">json_encode_object_start</span>(<span style="color: #000000">enc</span>);
+ <span style="color: #000000">json_encode_object_entry</span>(<span style="color: #000000">enc</span>, <span style="color: #C41A16">"images"</span>, <span style="color: #000000">&array</span>);
+ <span style="color: #000000">json_encode_object_finish</span>(<span style="color: #000000">enc</span>);
+
+ <span style="color: #A90D91">return</span> <span style="color: #1C01CE">0</span>;
+}
+</pre></div>
<div class="row">
@@ -661,8 +659,8 @@
</li>
<li class="pull-right">
- <a href=../json_encode_value/>
- Next: json_encode_value
+ <a href=../json_read_object/>
+ Next: json_read_object
<span class="fa fa-arrow-right"></span>
</a>
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/d4c7aea6/os/modules/json/json_encode_value/index.html
----------------------------------------------------------------------
diff --git a/os/modules/json/json_encode_value/index.html b/os/modules/json/json_encode_value/index.html
deleted file mode 100644
index 76f2481..0000000
--- a/os/modules/json/json_encode_value/index.html
+++ /dev/null
@@ -1,713 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <meta charset="utf-8">
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
-
-
- <link rel="canonical" href="http://mynewt.apache.org/os/modules/json/json_encode_value/">
- <link rel="shortcut icon" href="../../../../img/favicon.ico">
-
- <title>json_encode_value - Apache Mynewt</title>
-
- <link href="../../../../css/bootstrap-3.0.3.min.css" rel="stylesheet">
- <link href="../../../../css/font-awesome-4.0.3.css" rel="stylesheet">
- <link rel="stylesheet" href="../../../../css/highlight.css">
- <link href="../../../../css/base.css" rel="stylesheet">
- <link href="../../../../css/custom.css" rel="stylesheet">
- <link href='https://fonts.googleapis.com/css?family=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'>
- <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
- <link href="../../../../extra.css" rel="stylesheet">
-
- <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
- <!--[if lt IE 9]>
- <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
- <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
- <![endif]-->
-
-
- <script>
- (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
- (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
- m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
- })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
-
- ga('create', 'UA-72162311-1', 'mynewt.incubator.apache.org');
- ga('send', 'pageview');
- </script>
-
- </head>
-
-
- <body class="json_encode_value">
-
-
- <div id="navbar" class="navbar navbar-default navbar-fixed-top" role="navigation">
- <div class="logo-container">
- <img src="/img/logo.svg">
- </div>
- <div class="container-fluid">
- <!-- Collapsed navigation -->
- <div class="navbar-header">
- <!-- Expander button -->
- <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
- <span class="sr-only">Toggle navigation</span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- </button>
-
- </div>
-
- <!-- Expanded navigation -->
- <div class="navbar-collapse collapse">
- <!-- Main navigation -->
- <ul class="nav navbar-nav navbar-right">
- <li>
- <a href="/">Home</a>
- </li>
- <li>
- <a href="/about/">About</a>
- </li>
- <li class="dropdown">
- <a href="/documentation/" class="dropdown-toggle" data-toggle="dropdown">Docs <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-
-
-
-
- <li >
- <a href="../../../../documentation/">
- Overview
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="active">
- <a href="../../../get_started/introduction/">
- Mynewt OS Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../../newt/newt_intro/">
- Newt Tool Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../../newtmgr/overview/">
- Newt Manager Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../tutorials/how_to_edit_docs/">
- Appendix
- </a>
- </li>
-
-
- </ul>
- </li>
- <li>
- <a href="/download/">Download</a>
- </li>
- <li>
- <a href="/community/">Community</a>
- </li>
- <li>
- <a href="/events/">Events</a>
- </li>
- </ul>
-
- <!-- Search, Navigation and Repo links -->
- <ul class="nav navbar-nav navbar-right">
-
- </ul>
- </div>
- </div>
-</div>
-
-
-
- <div class="container-fluid">
-
- <div class="row sm-extra-padding">
- <div id="docSidebar" class="col-md-3 bg-grey sidebar-container"><div class="bs-sidebar hidden-print" role="complementary">
- <div class="sidebar-top">
- <img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt">
- <div class="small" role="search">
- <form id ="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
- <div class="form-group">
- <input type="text" name="q" placeholder="Search documentation" />
- <button class="search-button" type="submit"><i class="fa fa-search"></i></button>
- </div>
- </form>
- </div>
- </div>
- <ul class="nav bs-sidenav">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li><a href="
- ../../../get_started/introduction/
-">Mynewt OS Manual</a>
-
-
- <ul class="current-toc">
-
-
-
-
- <li>
- <a href="../../../get_started/introduction/">Introduction</a>
- </li>
-
-
-
-
-
-
-
-
- <li ><a href="../../../get_started/get_started/">Quick Start</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../../get_started/vocabulary/">Concepts</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../../tutorials/tutorials/">Tutorials</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../../os_user_guide/">OS User Guide</a></li>
-
-
- <ul class="current-toc">
-
-
-
-
-
-
-
- <li ><a href="../../../core_os/mynewt_os/">OS Core</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../../core_os/porting/port_os/">Porting to your Platform</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../console/console/">Console</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../shell/shell/">Shell</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../bootloader/bootloader/">Bootloader</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li><a href="
-
-
- ../../fs/fs/fs/
-
-">File System</a>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../hal/hal/">Hardware Abstraction Layer</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../testutil/testutil/">Test Utilities</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../imgmgr/imgmgr/">Image Manager</a></li>
-
-
- </li>
-
-
-
-
-
-
- <li>
- <a href="../../baselibc/">Baselibc library</a>
- </li>
-
-
-
-
-
-
-
-
- <li ><a href="../../elua/elua/">Embedded Lua</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../json/">JSON</a></li>
-
-
- <ul class="current-toc">
-
-
-
-
-
-
-
- <li><a href="
- ../json_encode_object_entry/
-">Functions</a>
-
-
- <ul class="current-toc">
-
-
-
-
- <li>
- <a href="../json_encode_object_entry/">json_encode_object_entry</a>
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_encode_object_finish/">json_encode_object_finish</a>
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_encode_object_key/">json_encode_object_key</a>
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_encode_object_start/">json_encode_object_start</a>
- </li>
-
-
-
-
-
-
-
- <li class="active">
- json_encode_value
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_internal_read_object/">json_internal_read_object</a>
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_read_array/">json_read_array</a>
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_read_object/">json_read_object</a>
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_target_address/">json_target_address</a>
- </li>
-
-
-
-
- </ul>
-
- </li>
-
-
-
- </ul>
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../stats/stats/">Stats</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../logs/logs/">Logs</a></li>
-
-
- </li>
-
-
-
- </ul>
-
- </li>
-
-
-
-
-
-
-
- <li><a href="
- ../../../../network/ble/ble_intro/
-">BLE User Guide</a>
-
-
- </li>
-
-
-
- </ul>
-
- </li>
-
-
-
-
-
-
-
- <li><a href="
- ../../../../newt/newt_intro/
-">Newt Tool Manual</a>
-
-
- </li>
-
-
-
-
-
-
-
- <li><a href="
- ../../../../newtmgr/overview/
-">Newt Manager Manual</a>
-
-
- </li>
-
-
-
-
-
-
-
- <li><a href="
- ../../../tutorials/how_to_edit_docs/
-">Appendix</a>
-
-
- </li>
-
-
-
- </ul>
-</div></div>
-
- <div class="show-sidebar-container">
- <button class="show-sidebar">Docs Menu</button>
- </div>
-
- <div class="col-md-offset-3 col-md-9 documentation-viewer" role="main">
- <div class="row doc-header">
- <div class="col-sm-6">
-
-<ul class="nav nav-pills">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="active" role="presentation"><a href="../../../get_started/introduction/">Mynewt OS</a></li>
-
-
-
- <li role="presentation"><a href="../../../../newt/newt_intro/">Newt Tool</a></li>
-
-
-
- <li role="presentation"><a href="../../../../newtmgr/overview/">Newt Mgr</a></li>
-
-
-
-
-</ul>
- </div>
- <div class="col-sm-6">
- <div role="navigation" aria-label="breadcrumbs navigation">
- <ul class="wy-breadcrumbs">
- <li><a href="/documentation/">Docs</a></li>
-
-
-
- <li>» <a href="../json/">JSON</a></li>
-
-
-
- <li>» <a href="../json_encode_object_entry/">Functions</a></li>
-
-
-
- <li>» json_encode_value</li>
-
-
-
- </ul>
-</div>
- </div>
- </div>
-
-
-
- <div class="row">
-
-
-
-
-<ul class="nav nav-pills" style="margin-bottom: 10px">
- <li>
-
- <a href=../json_encode_object_start/>
- <span class="fa fa-arrow-left"></span>
- Previous: json_encode_object_start
- </a>
-
- </li>
- <li class="pull-right">
-
- <a href=../json_internal_read_object/>
- Next: json_internal_read_object
- <span class="fa fa-arrow-right"></span>
- </a>
-
- </li>
-</ul>
- </div>
- <div class="row">
- <footer>
- <div class="row">
- <div class="col-md-12">
-
- <p class="copyright">Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0 Apache and the Apache feather logo are trademarks of The Apache Software Foundation.<br>The Apache Software Foundation Apache Incubator</p>
-
- </div>
- </div>
- <div class="copyright-logos">
- <div class="row">
- <div class="col-xs-6 text-right">
- <img src="/img/apache-feather.png" alt="Apache" title="Apache">
- </div>
- <div class="col-xs-6 text-left">
- <img src="/img/apache-logo.png" alt="Apache Incubator" title="Apache Incubator">
- </div>
- </div>
- </div>
- <div class="row">
- <div class="col-md-12">
- <small class="footnote">
- MyNewt is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
- </small>
- </div>
- </div>
-</footer>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <script src="../../../../js/jquery-1.10.2.min.js"></script>
- <script src="../../../../js/bootstrap-3.0.3.min.js"></script>
- <script src="../../../../js/highlight.pack.js"></script>
- <script src="../../../../js/base.js"></script>
- <script src="../../../../js/custom.js"></script>
-
- </body>
-</html>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-mynewt-site/blob/d4c7aea6/os/modules/json/json_internal_read_object/index.html
----------------------------------------------------------------------
diff --git a/os/modules/json/json_internal_read_object/index.html b/os/modules/json/json_internal_read_object/index.html
deleted file mode 100644
index a918ae5..0000000
--- a/os/modules/json/json_internal_read_object/index.html
+++ /dev/null
@@ -1,713 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
- <head>
- <meta charset="utf-8">
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
-
-
- <link rel="canonical" href="http://mynewt.apache.org/os/modules/json/json_internal_read_object/">
- <link rel="shortcut icon" href="../../../../img/favicon.ico">
-
- <title>json_internal_read_object - Apache Mynewt</title>
-
- <link href="../../../../css/bootstrap-3.0.3.min.css" rel="stylesheet">
- <link href="../../../../css/font-awesome-4.0.3.css" rel="stylesheet">
- <link rel="stylesheet" href="../../../../css/highlight.css">
- <link href="../../../../css/base.css" rel="stylesheet">
- <link href="../../../../css/custom.css" rel="stylesheet">
- <link href='https://fonts.googleapis.com/css?family=Roboto:400,500,700,900,300,100' rel='stylesheet' type='text/css'>
- <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
- <link href="../../../../extra.css" rel="stylesheet">
-
- <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
- <!--[if lt IE 9]>
- <script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
- <script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
- <![endif]-->
-
-
- <script>
- (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
- (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
- m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
- })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
-
- ga('create', 'UA-72162311-1', 'mynewt.incubator.apache.org');
- ga('send', 'pageview');
- </script>
-
- </head>
-
-
- <body class="json_internal_read_object">
-
-
- <div id="navbar" class="navbar navbar-default navbar-fixed-top" role="navigation">
- <div class="logo-container">
- <img src="/img/logo.svg">
- </div>
- <div class="container-fluid">
- <!-- Collapsed navigation -->
- <div class="navbar-header">
- <!-- Expander button -->
- <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
- <span class="sr-only">Toggle navigation</span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- <span class="icon-bar"></span>
- </button>
-
- </div>
-
- <!-- Expanded navigation -->
- <div class="navbar-collapse collapse">
- <!-- Main navigation -->
- <ul class="nav navbar-nav navbar-right">
- <li>
- <a href="/">Home</a>
- </li>
- <li>
- <a href="/about/">About</a>
- </li>
- <li class="dropdown">
- <a href="/documentation/" class="dropdown-toggle" data-toggle="dropdown">Docs <b class="caret"></b></a>
- <ul class="dropdown-menu">
-
-
-
-
-
-
- <li >
- <a href="../../../../documentation/">
- Overview
- </a>
- </li>
-
-
-
-
-
-
-
-
-
- <li class="active">
- <a href="../../../get_started/introduction/">
- Mynewt OS Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../../newt/newt_intro/">
- Newt Tool Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../../newtmgr/overview/">
- Newt Manager Manual
- </a>
- </li>
-
-
-
- <li >
- <a href="../../../tutorials/how_to_edit_docs/">
- Appendix
- </a>
- </li>
-
-
- </ul>
- </li>
- <li>
- <a href="/download/">Download</a>
- </li>
- <li>
- <a href="/community/">Community</a>
- </li>
- <li>
- <a href="/events/">Events</a>
- </li>
- </ul>
-
- <!-- Search, Navigation and Repo links -->
- <ul class="nav navbar-nav navbar-right">
-
- </ul>
- </div>
- </div>
-</div>
-
-
-
- <div class="container-fluid">
-
- <div class="row sm-extra-padding">
- <div id="docSidebar" class="col-md-3 bg-grey sidebar-container"><div class="bs-sidebar hidden-print" role="complementary">
- <div class="sidebar-top">
- <img class="hidden-xs hidden-sm logo-small" src="/img/logo.svg" alt="MyNewt" title="MyNewt">
- <div class="small" role="search">
- <form id ="rtd-search-form" class="wy-form" action="../../../../search.html" method="get">
- <div class="form-group">
- <input type="text" name="q" placeholder="Search documentation" />
- <button class="search-button" type="submit"><i class="fa fa-search"></i></button>
- </div>
- </form>
- </div>
- </div>
- <ul class="nav bs-sidenav">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li><a href="
- ../../../get_started/introduction/
-">Mynewt OS Manual</a>
-
-
- <ul class="current-toc">
-
-
-
-
- <li>
- <a href="../../../get_started/introduction/">Introduction</a>
- </li>
-
-
-
-
-
-
-
-
- <li ><a href="../../../get_started/get_started/">Quick Start</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../../get_started/vocabulary/">Concepts</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../../tutorials/tutorials/">Tutorials</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../../os_user_guide/">OS User Guide</a></li>
-
-
- <ul class="current-toc">
-
-
-
-
-
-
-
- <li ><a href="../../../core_os/mynewt_os/">OS Core</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../../core_os/porting/port_os/">Porting to your Platform</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../console/console/">Console</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../shell/shell/">Shell</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../bootloader/bootloader/">Bootloader</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li><a href="
-
-
- ../../fs/fs/fs/
-
-">File System</a>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../hal/hal/">Hardware Abstraction Layer</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../testutil/testutil/">Test Utilities</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../imgmgr/imgmgr/">Image Manager</a></li>
-
-
- </li>
-
-
-
-
-
-
- <li>
- <a href="../../baselibc/">Baselibc library</a>
- </li>
-
-
-
-
-
-
-
-
- <li ><a href="../../elua/elua/">Embedded Lua</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../json/">JSON</a></li>
-
-
- <ul class="current-toc">
-
-
-
-
-
-
-
- <li><a href="
- ../json_encode_object_entry/
-">Functions</a>
-
-
- <ul class="current-toc">
-
-
-
-
- <li>
- <a href="../json_encode_object_entry/">json_encode_object_entry</a>
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_encode_object_finish/">json_encode_object_finish</a>
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_encode_object_key/">json_encode_object_key</a>
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_encode_object_start/">json_encode_object_start</a>
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_encode_value/">json_encode_value</a>
- </li>
-
-
-
-
-
-
-
- <li class="active">
- json_internal_read_object
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_read_array/">json_read_array</a>
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_read_object/">json_read_object</a>
- </li>
-
-
-
-
-
-
-
- <li>
- <a href="../json_target_address/">json_target_address</a>
- </li>
-
-
-
-
- </ul>
-
- </li>
-
-
-
- </ul>
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../stats/stats/">Stats</a></li>
-
-
- </li>
-
-
-
-
-
-
-
- <li ><a href="../../logs/logs/">Logs</a></li>
-
-
- </li>
-
-
-
- </ul>
-
- </li>
-
-
-
-
-
-
-
- <li><a href="
- ../../../../network/ble/ble_intro/
-">BLE User Guide</a>
-
-
- </li>
-
-
-
- </ul>
-
- </li>
-
-
-
-
-
-
-
- <li><a href="
- ../../../../newt/newt_intro/
-">Newt Tool Manual</a>
-
-
- </li>
-
-
-
-
-
-
-
- <li><a href="
- ../../../../newtmgr/overview/
-">Newt Manager Manual</a>
-
-
- </li>
-
-
-
-
-
-
-
- <li><a href="
- ../../../tutorials/how_to_edit_docs/
-">Appendix</a>
-
-
- </li>
-
-
-
- </ul>
-</div></div>
-
- <div class="show-sidebar-container">
- <button class="show-sidebar">Docs Menu</button>
- </div>
-
- <div class="col-md-offset-3 col-md-9 documentation-viewer" role="main">
- <div class="row doc-header">
- <div class="col-sm-6">
-
-<ul class="nav nav-pills">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class="active" role="presentation"><a href="../../../get_started/introduction/">Mynewt OS</a></li>
-
-
-
- <li role="presentation"><a href="../../../../newt/newt_intro/">Newt Tool</a></li>
-
-
-
- <li role="presentation"><a href="../../../../newtmgr/overview/">Newt Mgr</a></li>
-
-
-
-
-</ul>
- </div>
- <div class="col-sm-6">
- <div role="navigation" aria-label="breadcrumbs navigation">
- <ul class="wy-breadcrumbs">
- <li><a href="/documentation/">Docs</a></li>
-
-
-
- <li>» <a href="../json/">JSON</a></li>
-
-
-
- <li>» <a href="../json_encode_object_entry/">Functions</a></li>
-
-
-
- <li>» json_internal_read_object</li>
-
-
-
- </ul>
-</div>
- </div>
- </div>
-
-
-
- <div class="row">
-
-
-
-
-<ul class="nav nav-pills" style="margin-bottom: 10px">
- <li>
-
- <a href=../json_encode_value/>
- <span class="fa fa-arrow-left"></span>
- Previous: json_encode_value
- </a>
-
- </li>
- <li class="pull-right">
-
- <a href=../json_read_array/>
- Next: json_read_array
- <span class="fa fa-arrow-right"></span>
- </a>
-
- </li>
-</ul>
- </div>
- <div class="row">
- <footer>
- <div class="row">
- <div class="col-md-12">
-
- <p class="copyright">Copyright © 2015 The Apache Software Foundation, Licensed under the Apache License, Version 2.0 Apache and the Apache feather logo are trademarks of The Apache Software Foundation.<br>The Apache Software Foundation Apache Incubator</p>
-
- </div>
- </div>
- <div class="copyright-logos">
- <div class="row">
- <div class="col-xs-6 text-right">
- <img src="/img/apache-feather.png" alt="Apache" title="Apache">
- </div>
- <div class="col-xs-6 text-left">
- <img src="/img/apache-logo.png" alt="Apache Incubator" title="Apache Incubator">
- </div>
- </div>
- </div>
- <div class="row">
- <div class="col-md-12">
- <small class="footnote">
- MyNewt is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.
- </small>
- </div>
- </div>
-</footer>
- </div>
- </div>
- </div>
-
-
- </div>
-
- <script src="../../../../js/jquery-1.10.2.min.js"></script>
- <script src="../../../../js/bootstrap-3.0.3.min.js"></script>
- <script src="../../../../js/highlight.pack.js"></script>
- <script src="../../../../js/base.js"></script>
- <script src="../../../../js/custom.js"></script>
-
- </body>
-</html>
\ No newline at end of file