Skip to content

Commit

Permalink
jansson: removed empty parameters section
Browse files Browse the repository at this point in the history
- added section ids
  • Loading branch information
miconda committed May 14, 2016
1 parent 38bdeee commit 92dcec8
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 51 deletions.
60 changes: 23 additions & 37 deletions modules/jansson/README
Expand Up @@ -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

Expand All @@ -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

Expand All @@ -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'.
Expand All @@ -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'.

Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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'.
Expand Down Expand Up @@ -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'.
Expand Down
20 changes: 6 additions & 14 deletions modules/jansson/doc/jansson_admin.xml
Expand Up @@ -51,23 +51,15 @@
</para>
</section>
</section>
<section>
<title>Parameters</title>
<section>
<para>
<emphasis>None</emphasis>
</para>
</section>
</section>

<section>
<title>Functions</title>
<section>
<section id="jansson.f.jansson_get">
<title>
<function moreinfo="none">jansson_get(key/path, src, dst)</function>
</title>
<para>
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'.
</para>
<para>
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).
Expand All @@ -92,7 +84,7 @@ xlog("L_INFO", "foo is $var(n)");
</programlisting>
</example>
</section>
<section>
<section id="jansson.f.jansson_set">
<title>
<function moreinfo="none">jansson_set(type, key/path, value, result)</function>
</title>
Expand Down Expand Up @@ -131,7 +123,7 @@ jansson_set("str", "myobj.foo", "baz", "$var(myjson)");
</programlisting>
</example>
</section>
<section>
<section id="jansson.f.jansson_append">
<title>
<function moreinfo="none">jansson_append(type, key/path, value, result)</function>
</title>
Expand Down Expand Up @@ -170,7 +162,7 @@ jansson_append('obj', "", '{"a":1, "b":100}', "$var(newobj)");
</programlisting>
</example>
</section>
<section>
<section id="jansson.f.jansson_array_size">
<title>
<function moreinfo="none">jansson_array_size(key/path, src, dst)</function>
</title>
Expand Down Expand Up @@ -212,7 +204,7 @@ while($var(count) &lt; $var(appendme_size)) {
</programlisting>
</example>
</section>
<section>
<section id="jansson.f.jansson_get_field">
<title>
<function moreinfo="none">jansson_get_field(src, field_name, dst)</function>
</title>
Expand Down

0 comments on commit 92dcec8

Please sign in to comment.