[sr-dev] git:master:47c7dfb8: uid_gflags: dedicated sections for rpc commands in docs

Module: kamailio Branch: master Commit: 47c7dfb801d63cbfb29dbf234c06c2deef17fdc4 URL: https://github.com/kamailio/kamailio/commit/47c7dfb801d63cbfb29dbf234c06c2d… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: 2017-01-10T23:16:33+01:00 uid_gflags: dedicated sections for rpc commands in docs --- Modified: src/modules/uid_gflags/doc/xmlrpc.xml --- Diff: https://github.com/kamailio/kamailio/commit/47c7dfb801d63cbfb29dbf234c06c2d… Patch: https://github.com/kamailio/kamailio/commit/47c7dfb801d63cbfb29dbf234c06c2d… --- diff --git a/src/modules/uid_gflags/doc/xmlrpc.xml b/src/modules/uid_gflags/doc/xmlrpc.xml index 078ffd6..42fec0e 100644 --- a/src/modules/uid_gflags/doc/xmlrpc.xml +++ b/src/modules/uid_gflags/doc/xmlrpc.xml @@ -8,58 +8,59 @@ ]> -<section id="gflags.xmlrpc" xmlns:xi="http://www.w3.org/2001/XInclude"> - <sectioninfo> - </sectioninfo> - - <title>RPC Interface</title> +<section id="gflags.rpc" xmlns:xi="http://www.w3.org/2001/XInclude"> + <title>RPC Commands</title> <para> The state of the global flags can be read and modified over the RPC interface. This module implements the following RPC interface commands: </para> - <itemizedlist> - <listitem> + <section id="uid_gflags.r.gflags.set"> + <title>gflags.set</title> <para> <emphasis>gflags.set</emphasis> - Set the value of a flag to 1. The function accepts one parameter which is the number of the flag to be set. </para> - </listitem> - <listitem> + </section> + <section id="uid_gflags.r.gflags.reset"> + <title>gflags.reset</title> <para> <emphasis>gflags.reset</emphasis> - Reset the value of a flag to 0. The function accepts one parameter which is the number of the flag to be reset. </para> - </listitem> - <listitem> + </section> + <section id="uid_gflags.r.gflags.is_set"> + <title>gflags.is_set</title> <para> <emphasis>gflags.is_set</emphasis> - Return the status of a flag. The FIFO function would return TRUE if the flag is set and FALSE if it is not set. The only parameter of this function is the number of the flag. </para> - </listitem> - <listitem> + </section> + <section id="uid_gflags.r.gflags.flush"> + <title>gflags.flush</title> <para> <emphasis>gflags.flush</emphasis> - Flush the state of global flags into database. </para> - </listitem> - <listitem> + </section> + <section id="uid_gflags.r.gflags.dump"> + <title>gflags.dump</title> <para> - <emphasis>gflags.dump</emphasis> - Return the status of all flags. The - value is TRUE if the flag is set and FALSE if the flag is not set. The + <emphasis>gflags.dump</emphasis> - Return the status of all flags. The + value is TRUE if the flag is set and FALSE if the flag is not set. The function has no parameters. </para> - </listitem> - <listitem> + </section> + <section id="uid_gflags.r.global.reload"> + <title>global.reload</title> <para> - <emphasis>global.reload</emphasis> - Reload values from global_attrs + <emphasis>global.reload</emphasis> - Reload values from global_attrs DB table. This function does not have any parameters. There is no return - value on success. + value on success. </para> - </listitem> - </itemizedlist> + </section> </section>