From 0559b9eecb83415e69b9243715199b37d16af185 Mon Sep 17 00:00:00 2001 From: Daniel-Constantin Mierla Date: Mon, 13 Nov 2023 15:36:11 +0100 Subject: [PATCH] xcap_client: docs - removed trailing spaces --- src/modules/xcap_client/doc/xcap_client.xml | 6 ++-- .../xcap_client/doc/xcap_client_admin.xml | 2 +- .../xcap_client/doc/xcap_client_devel.xml | 32 +++++++++---------- 3 files changed, 20 insertions(+), 20 deletions(-) diff --git a/src/modules/xcap_client/doc/xcap_client.xml b/src/modules/xcap_client/doc/xcap_client.xml index e95988f571f..d6ffb4ea6a4 100644 --- a/src/modules/xcap_client/doc/xcap_client.xml +++ b/src/modules/xcap_client/doc/xcap_client.xml @@ -35,11 +35,11 @@ - + - - + + diff --git a/src/modules/xcap_client/doc/xcap_client_admin.xml b/src/modules/xcap_client/doc/xcap_client_admin.xml index 2fa9c1b4f1e..dfeb652c32b 100644 --- a/src/modules/xcap_client/doc/xcap_client_admin.xml +++ b/src/modules/xcap_client/doc/xcap_client_admin.xml @@ -34,7 +34,7 @@ The update method is also configurable, either through periodical - queries, applicable to any kind of XCAP server or with a management command + queries, applicable to any kind of XCAP server or with a management command that should be sent by the server upon an update. diff --git a/src/modules/xcap_client/doc/xcap_client_devel.xml b/src/modules/xcap_client/doc/xcap_client_devel.xml index cd4579ef30e..14772fba9ec 100644 --- a/src/modules/xcap_client/doc/xcap_client_devel.xml +++ b/src/modules/xcap_client/doc/xcap_client_devel.xml @@ -10,10 +10,10 @@ - + &develguide; - The module exports a number of functions that allow selecting + The module exports a number of functions that allow selecting and retrieving an element from an xcap server and also registering a callback to be called when the management command refreshXcapDoc is received and the document in question is retrieved. @@ -23,21 +23,21 @@ bind_xcap_api(xcap_api_t* api) - This function allows binding the needed functions. + This function allows binding the needed functions. <function>xcap_api</function> structure ... typedef struct xcap_api { - + /* xcap node selection and retrieving functions*/ xcap_get_elem_t get_elem; xcap_nodeSel_init_t int_node_sel; xcap_nodeSel_add_step_t add_step; xcap_nodeSel_add_terminal_t add_terminal; xcap_nodeSel_free_t free_node_sel; - xcapGetNewDoc_t getNewDoc; /* an initial request for the module + xcapGetNewDoc_t getNewDoc; /* an initial request for the module to fetch this document that does not exist in xcap db table and handle its update*/ @@ -48,7 +48,7 @@ typedef struct xcap_api { - +
<function moreinfo="none">get_elem</function> @@ -61,7 +61,7 @@ typedef char* (*xcap_get_elem_t)(char* xcap_root, xcap_doc_sel_t* doc_sel, xcap_node_sel_t* node_sel); ... </programlisting> - </para> + </para> <para> This function sends a HTTP request and gets the specified information from the xcap server. @@ -90,15 +90,15 @@ typedef struct xcap_doc_sel int type; /* the type of the path segment after the AUID which must either be GLOBAL_TYPE (for "global") or - USERS_TYPE (for "users") */ - str xid; /* the XCAP User Identifier + USERS_TYPE (for "users") */ + str xid; /* the XCAP User Identifier if type is USERS_TYPE */ - str filename; + str filename; }xcap_doc_sel_t; ... </programlisting> </listitem> - + <listitem> <para> <emphasis>node_sel</emphasis>- @@ -135,14 +135,14 @@ typedef struct ns_list </programlisting> <para> The node selector is represented like a list of steps that will - be represented in the path string separated by '/' signs. + be represented in the path string separated by '/' signs. The namespaces for the nodes are stored also in a list, as an association of name and value, where the value is to be included in the respective string val field of the step. </para> <para> To construct the node structure the following functions in the xcap_api - structure should be used: 'int_node_sel', 'add_step' and if needed, + structure should be used: 'int_node_sel', 'add_step' and if needed, 'add_terminal'. </para> <para> @@ -150,8 +150,8 @@ typedef struct ns_list be NULL. </para> </listitem> - </itemizedlist> - + </itemizedlist> + </section> <section> <title> @@ -177,6 +177,6 @@ typedef int (xcap_cb)(int doc_type, str xid, char* doc); ... </programlisting> </para> - </section> + </section> </chapter>