Explorar el Código

jansson: removed empty parameters section

- added section ids
Daniel-Constantin Mierla hace 9 años
padre
commit
92dcec82b4
Se han modificado 2 ficheros con 29 adiciones y 51 borrados
  1. 23 37
      modules/jansson/README
  2. 6 14
      modules/jansson/doc/jansson_admin.xml

+ 23 - 37
modules/jansson/README

@@ -23,17 +23,13 @@ Matthew Williams
               2.1. Kamailio Modules
               2.1. Kamailio Modules
               2.2. External Libraries or Applications
               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
    List of Examples
 
 
@@ -54,17 +50,13 @@ Chapter 1. Admin Guide
         2.1. Kamailio Modules
         2.1. Kamailio Modules
         2.2. External Libraries or Applications
         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
 1. Overview
 
 
@@ -87,21 +79,15 @@ Chapter 1. Admin Guide
    running Kamailio with this module loaded:
    running Kamailio with this module loaded:
      * jansson (http://www.digip.org/jansson/), tested with: 2.2+
      * 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
    Copy the value at the location 'path' from the json object 'src' and
    store it in pvar 'dst'.
    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)");
 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'.
    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"}}'
 :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
    Like jansson_set but can be used to append to arrays. It can also be
    used to combine two json objects.
    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}';
 # $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
    Puts the size of the array in 'src' at location 'path' into the pvar
    'dst'.
    '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
    Copy field 'field_name' from json object 'src' and store it in pvar
    'dst'.
    'dst'.

+ 6 - 14
modules/jansson/doc/jansson_admin.xml

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