[sr-dev] git:master:64f49992: json: some enhancements to the docs

Module: kamailio Branch: master Commit: 64f499921f2b466729eba3c35f6a8c82ef990593 URL: https://github.com/kamailio/kamailio/commit/64f499921f2b466729eba3c35f6a8c8… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: 2016-05-16T11:53:22+02:00 json: some enhancements to the docs - referring to jansson module for more complex json operations - added id to exported function section --- Modified: modules/json/README Modified: modules/json/doc/json_admin.xml --- Diff: https://github.com/kamailio/kamailio/commit/64f499921f2b466729eba3c35f6a8c8… Patch: https://github.com/kamailio/kamailio/commit/64f499921f2b466729eba3c35f6a8c8… --- diff --git a/modules/json/README b/modules/json/README index b74bd69..dc3de58 100644 --- a/modules/json/README +++ b/modules/json/README @@ -47,7 +47,10 @@ Chapter 1. Admin Guide 1. Overview - This module provides operations on json strings. + This is a simple module allowing to retrieve values from a JSON string. + + For more complex operations with JSON documents, see the JANSSON + module. 2. Dependencies diff --git a/modules/json/doc/json_admin.xml b/modules/json/doc/json_admin.xml index d0084b0..3023692 100644 --- a/modules/json/doc/json_admin.xml +++ b/modules/json/doc/json_admin.xml @@ -14,7 +14,12 @@ <section> <title>Overview</title> <para> - This module provides operations on json strings. + This is a simple module allowing to retrieve values from + a JSON string. + </para> + <para> + For more complex operations with JSON documents, + see the JANSSON module. </para> </section> @@ -51,7 +56,7 @@ <section> <title>Functions</title> - <section> + <section id="json.f.json_get_field"> <title> <function moreinfo="none">json_get_field(json_string, field_name, destination)</function> </title>