Skip to content

Commit

Permalink
dialog: docs - removed trailing spaces
Browse files Browse the repository at this point in the history
  • Loading branch information
miconda committed Nov 13, 2023
1 parent 8dd4eed commit 34a51df
Show file tree
Hide file tree
Showing 4 changed files with 30 additions and 30 deletions.
4 changes: 2 additions & 2 deletions src/modules/dialog/doc/dialog.xml
Expand Up @@ -74,9 +74,9 @@
</copyright>
</bookinfo>
<toc></toc>

<xi:include href="dialog_admin.xml"/>
<xi:include href="dialog_devel.xml"/>
<xi:include href="dialog_faq.xml"/>

</book>
30 changes: 15 additions & 15 deletions src/modules/dialog/doc/dialog_admin.xml
Expand Up @@ -63,7 +63,7 @@
<title>Dialog states</title>
<para>
Dialogs have states that are shown in the RPC interface as well as stored
in the database.
in the database.
</para>
<itemizedlist>
<listitem>
Expand Down Expand Up @@ -92,7 +92,7 @@
Dialog profiling is a mechanism that helps in classifying, sorting and
keeping track of certain types of dialogs. The classification criteria
can be any attributes desired by the administrator; it can be SIP message
attributes, other pseudo-variables, custom values, etc.
attributes, other pseudo-variables, custom values, etc.
Dialogs can be dynamically added into one or more profile
tables. Logically, each profile table can have a special meaning (like
dialogs outside the domain, dialogs terminated to the PSTN, etc.).
Expand All @@ -103,8 +103,8 @@
<listitem>
<para>
<emphasis>with no value</emphasis> - a dialog simply belongs
to a profile (for instance, an outbound calls profile). There is
no other additional information to describe the dialog beyond
to a profile (for instance, an outbound calls profile). There is
no other additional information to describe the dialog beyond
its membership in the profile per se.
</para>
</listitem>
Expand All @@ -115,7 +115,7 @@
is the caller ID). The membership of the dialog in the profile is
strictly related to the value. For example, if the account ID
of the caller is stored in the pseudo-variable $var(account_id),
you can use $var(account_id) as a value/key by which to group
you can use $var(account_id) as a value/key by which to group
dialogs so that you can count the number of open dialogs for
each account, enforce concurrent call limits as necessary, etc.
</para>
Expand Down Expand Up @@ -416,8 +416,8 @@ modparam("dialog", "dlg_extra_hdrs", "Hint: credit expired\r\n")
<para>
Note: DID-based matching does not replace callid/fromtag/totag comparison. It will speed
up dialog matching by not iterating over the whole dialog list for callid/fromtag/totag comparison, but
instead it uses a hash table to find the respective dialog and then doing only one callid/fromtag/totag
comparison. Thus, there is no security
instead it uses a hash table to find the respective dialog and then doing only one callid/fromtag/totag
comparison. Thus, there is no security
issue when using DID based matching. Use DID_FALLBACK for maximum interoperability or use DID_ONLY to
reject buggy clients or hacking attempts. DID_NONE is only useful, when you want to hide dialog-tracking
from the users (preventing the DID Record-Route cookie).
Expand Down Expand Up @@ -570,11 +570,11 @@ modparam("dialog", "db_update_period", 120)
<section id="dialog.p.db_fetch_rows">
<title><varname>db_fetch_rows</varname> (integer)</title>
<para>
The number of the rows to be fetched at once from database
The number of the rows to be fetched at once from database
when loading the dialog records at startup from the database.
This value can be used to tune the load time at startup.
This value can be used to tune the load time at startup.
For 1MB of private memory (default), it should be below 400.
The database driver must support the fetch_result() capability.
The database driver must support the fetch_result() capability.
A value of 0 means the database fetch is not limited.
</para>
<para>
Expand Down Expand Up @@ -1138,7 +1138,7 @@ modparam("dialog", "vars_key_column", "vars_key_name")
<section id="dialog.p.vars_value_column">
<title><varname>vars_value_column</varname> (string)</title>
<para>
The column name in the database to store the values of a
The column name in the database to store the values of a
dialog variable.
</para>
<para>
Expand Down Expand Up @@ -1180,7 +1180,7 @@ modparam("dialog", "profiles_with_value", "caller ; my_profile")
<section id="dialog.p.profiles_no_value">
<title><varname>profiles_no_value</varname> (string)</title>
<para>
List of names for profiles without values, separated
List of names for profiles without values, separated
with semi-colon ";".
</para>
<para>
Expand Down Expand Up @@ -1449,7 +1449,7 @@ modparam("dialog", "timeout_noreset", 1)
<section id="dialog.p.timer_procs">
<title><varname>timer_procs</varname> (int)</title>
<para>
If set to 1, the dialog module will start a separate
If set to 1, the dialog module will start a separate
dialog timer process to execute dialog timeout tasks.
The default is to use the core timer process.
</para>
Expand Down Expand Up @@ -2025,7 +2025,7 @@ dlg_resetflag("1");
<function moreinfo="none">dlg_bye(side)</function>
</title>
<para>
Send BYE to parties of a dialog or - if in early stage - a CANCEL to the
Send BYE to parties of a dialog or - if in early stage - a CANCEL to the
B-Party and a SIP response to the A-Party (as defined in bye_early_code /
bye_early_reason).
</para>
Expand Down Expand Up @@ -2674,7 +2674,7 @@ dlg_reset_property("timeout-noreset");
<emphasis>content</emphasis> (optional) - Content to be sent as body.
</para>
</listitem>
</itemizedlist>
</itemizedlist>
<para>
This function can be used from ANY_ROUTE.
</para>
Expand Down
18 changes: 9 additions & 9 deletions src/modules/dialog/doc/dialog_devel.xml
Expand Up @@ -25,23 +25,23 @@
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
<listitem>
<para><emphasis>struct dlg_cell* dlg</emphasis> - dialog to
<para><emphasis>struct dlg_cell* dlg</emphasis> - dialog to
register callback to. It may be NULL only for DLGCB_CREATED callback
type, which is not a per dialog type.
</para>
</listitem>
<listitem>
<para><emphasis>int type</emphasis> - types of callbacks; more
types may be registered for the same callback function; only
types may be registered for the same callback function; only
DLGCB_LOADED and DLGCB_CREATED must be registered alone. Possible types:
<itemizedlist>
<listitem>
<para><emphasis>DLGCB_LOADED</emphasis>
</para>
</listitem>
<listitem>
<para><emphasis>DLGCB_CREATED</emphasis> - called when a new
dialog is created - it's a global type (not associated to
<para><emphasis>DLGCB_CREATED</emphasis> - called when a new
dialog is created - it's a global type (not associated to
any dialog)
</para>
</listitem>
Expand All @@ -63,14 +63,14 @@
</para>
</listitem>
<listitem>
<para><emphasis>DLGCB_REQ_WITHIN</emphasis> - called when the
<para><emphasis>DLGCB_REQ_WITHIN</emphasis> - called when the
dialog matches a sequential request (excluding setup-concluding
ACK messages which are handled in DLGCB_CONFIRMED) - it's a per
dialog type.
</para>
</listitem>
<listitem>
<para><emphasis>DLGCB_TERMINATED</emphasis> - called when the
<para><emphasis>DLGCB_TERMINATED</emphasis> - called when the
dialog is terminated via BYE - it's a per dialog type.
</para>
</listitem>
Expand Down Expand Up @@ -134,7 +134,7 @@
</para>
</listitem>
<listitem>
<para><emphasis>param_free callback_param_free</emphasis> -
<para><emphasis>param_free callback_param_free</emphasis> -
callback function to be called to free the param.
Prototype is: <quote>void (param_free_cb) (void *param);</quote>
</para>
Expand All @@ -154,12 +154,12 @@
<para>Meaning of parameters is as follows:</para>
<itemizedlist>
<listitem>
<para><emphasis>struct dlg_cell* dlg</emphasis> - dialog to
<para><emphasis>struct dlg_cell* dlg</emphasis> - dialog to
terminate.
</para>
</listitem>
<listitem>
<para><emphasis>str* hdrs</emphasis> - string containing extra headers (full format)
<para><emphasis>str* hdrs</emphasis> - string containing extra headers (full format)
to be added to the BYE requests of the dialog.
</para>
</listitem>
Expand Down
8 changes: 4 additions & 4 deletions src/modules/dialog/doc/dialog_faq.xml
Expand Up @@ -11,12 +11,12 @@
<!-- Module FAQ -->

<chapter>

<title>&faqguide;</title>
<qandaset defaultlabel="number">
<qandaentry>
<question>
<para>What happened with <quote>use_tight_match</quote>
<para>What happened with <quote>use_tight_match</quote>
parameter?</para>
</question>
<answer>
Expand Down Expand Up @@ -44,7 +44,7 @@
<answer>
<para>
First at all check if your question was already answered on one of
our mailing lists:
our mailing lists:
</para>
<itemizedlist>
<listitem>
Expand All @@ -55,7 +55,7 @@
</listitem>
</itemizedlist>
<para>
E-mails regarding any stable &kamailio; release should be sent to
E-mails regarding any stable &kamailio; release should be sent to
&kamailiousersmail; and e-mails regarding development versions
should be sent to &kamailiodevmail;.
</para>
Expand Down

0 comments on commit 34a51df

Please sign in to comment.