Skip to content

Commit

Permalink
dialog: proper description of is_in_profile() to match the code
Browse files Browse the repository at this point in the history
- reported by GH #1320
  • Loading branch information
miconda committed Nov 22, 2017
1 parent d9ca0f6 commit d319c44
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions src/modules/dialog/doc/dialog_admin.xml
Expand Up @@ -1608,11 +1608,12 @@ unset_dlg_profile("caller","$fu");
</title>
<para>
Checks if the current dialog belongs to a profile. If the profile
supports values, the check can be reinforced to take into account a
specific value, if the dialog was inserted into the profile for a
specific value. If no value is passed, only the membership of
the dialog in the profile per se is checked. Note that if the profile does
not support values, the value parameter will be silently discarded.
is defined with values, then the check is also matching with the
specific value provided as parameter.
</para>
<para>
Note that if the profile is not defined with support for values, the
value parameter will be silently discarded.
</para>
<para>Meaning of the parameters is as follows:</para>
<itemizedlist>
Expand All @@ -1623,13 +1624,13 @@ unset_dlg_profile("caller","$fu");
</listitem>
<listitem>
<para><emphasis>value</emphasis> (optional) - string value to
further restrict the check. Pseudo-variables are supported.
be matched during the check. Pseudo-variables are supported.
</para>
</listitem>
</itemizedlist>
<para>
This function can be used from REQUEST_ROUTE, BRANCH_ROUTE,
REPLY_ROUTE and FAILURE_ROUTE.
REPLY_ROUTE and FAILURE_ROUTE.
</para>
<example>
<title><function>is_in_profile</function> usage</title>
Expand Down

0 comments on commit d319c44

Please sign in to comment.