From 92dcec82b4f7e0de07e06d51bd57d612c949241c Mon Sep 17 00:00:00 2001 From: Daniel-Constantin Mierla Date: Sat, 14 May 2016 10:11:33 +0200 Subject: [PATCH] jansson: removed empty parameters section - added section ids --- modules/jansson/README | 60 ++++++++++----------------- modules/jansson/doc/jansson_admin.xml | 20 +++------ 2 files changed, 29 insertions(+), 51 deletions(-) diff --git a/modules/jansson/README b/modules/jansson/README index 113fb9af1d6..a85abc7e75f 100644 --- a/modules/jansson/README +++ b/modules/jansson/README @@ -23,17 +23,13 @@ Matthew Williams 2.1. Kamailio Modules 2.2. External Libraries or Applications - 3. Parameters + 3. Functions - 3.1. - - 4. Functions - - 4.1. jansson_get(key/path, src, dst) - 4.2. jansson_set(type, key/path, value, result) - 4.3. jansson_append(type, key/path, value, result) - 4.4. jansson_array_size(key/path, src, dst) - 4.5. jansson_get_field(src, field_name, dst) + 3.1. jansson_get(key/path, src, dst) + 3.2. jansson_set(type, key/path, value, result) + 3.3. jansson_append(type, key/path, value, result) + 3.4. jansson_array_size(key/path, src, dst) + 3.5. jansson_get_field(src, field_name, dst) List of Examples @@ -54,17 +50,13 @@ Chapter 1. Admin Guide 2.1. Kamailio Modules 2.2. External Libraries or Applications - 3. Parameters - - 3.1. - - 4. Functions + 3. Functions - 4.1. jansson_get(key/path, src, dst) - 4.2. jansson_set(type, key/path, value, result) - 4.3. jansson_append(type, key/path, value, result) - 4.4. jansson_array_size(key/path, src, dst) - 4.5. jansson_get_field(src, field_name, dst) + 3.1. jansson_get(key/path, src, dst) + 3.2. jansson_set(type, key/path, value, result) + 3.3. jansson_append(type, key/path, value, result) + 3.4. jansson_array_size(key/path, src, dst) + 3.5. jansson_get_field(src, field_name, dst) 1. Overview @@ -87,21 +79,15 @@ Chapter 1. Admin Guide running Kamailio with this module loaded: * jansson (http://www.digip.org/jansson/), tested with: 2.2+ -3. Parameters - - 3.1. - - None - -4. Functions +3. Functions - 4.1. jansson_get(key/path, src, dst) - 4.2. jansson_set(type, key/path, value, result) - 4.3. jansson_append(type, key/path, value, result) - 4.4. jansson_array_size(key/path, src, dst) - 4.5. jansson_get_field(src, field_name, dst) + 3.1. jansson_get(key/path, src, dst) + 3.2. jansson_set(type, key/path, value, result) + 3.3. jansson_append(type, key/path, value, result) + 3.4. jansson_array_size(key/path, src, dst) + 3.5. jansson_get_field(src, field_name, dst) -4.1. jansson_get(key/path, src, dst) +3.1. jansson_get(key/path, src, dst) Copy the value at the location 'path' from the json object 'src' and store it in pvar 'dst'. @@ -125,7 +111,7 @@ if(!jansson_get("inner.deep.list[3]", $var(myjson), "$var(n)")) { xlog("L_INFO", "foo is $var(n)"); ... -4.2. jansson_set(type, key/path, value, result) +3.2. jansson_set(type, key/path, value, result) Insert 'value' as 'type' at location 'path' into 'result'. @@ -160,7 +146,7 @@ jansson_set("str", "myobj.foo", "baz", "$var(myjson)"); :3.14159, "myobj":{"foo":"baz"}}' ... -4.3. jansson_append(type, key/path, value, result) +3.3. jansson_append(type, key/path, value, result) Like jansson_set but can be used to append to arrays. It can also be used to combine two json objects. @@ -194,7 +180,7 @@ jansson_append('obj', "", '{"a":1, "b":100}', "$var(newobj)"); # $var(newobj) == '{"a":1,"b":100","c":3}'; ... -4.4. jansson_array_size(key/path, src, dst) +3.4. jansson_array_size(key/path, src, dst) Puts the size of the array in 'src' at location 'path' into the pvar 'dst'. @@ -226,7 +212,7 @@ while($var(count) < $var(appendme_size)) { } ... -4.5. jansson_get_field(src, field_name, dst) +3.5. jansson_get_field(src, field_name, dst) Copy field 'field_name' from json object 'src' and store it in pvar 'dst'. diff --git a/modules/jansson/doc/jansson_admin.xml b/modules/jansson/doc/jansson_admin.xml index 344de6c8883..e33b71987fa 100644 --- a/modules/jansson/doc/jansson_admin.xml +++ b/modules/jansson/doc/jansson_admin.xml @@ -51,23 +51,15 @@ -
- Parameters -
- - None - -
-
Functions -
+
<function moreinfo="none">jansson_get(key/path, src, dst)</function> - Copy the value at the location 'path' from the json object 'src' and store it in pvar 'dst'. + Copy the value at the location 'path' from the json object 'src' and store it in pvar 'dst'. The path string supports dot delimited notation (e.g. foo.bar.baz), array notation (e.g. [0]), or a combination of the two (e.g. foo.bar[0][1].baz). @@ -92,7 +84,7 @@ xlog("L_INFO", "foo is $var(n)");
-
+
<function moreinfo="none">jansson_set(type, key/path, value, result)</function> @@ -131,7 +123,7 @@ jansson_set("str", "myobj.foo", "baz", "$var(myjson)");
-
+
<function moreinfo="none">jansson_append(type, key/path, value, result)</function> @@ -170,7 +162,7 @@ jansson_append('obj', "", '{"a":1, "b":100}', "$var(newobj)");
-
+
<function moreinfo="none">jansson_array_size(key/path, src, dst)</function> @@ -212,7 +204,7 @@ while($var(count) < $var(appendme_size)) {
-
+
<function moreinfo="none">jansson_get_field(src, field_name, dst)</function>