kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2025-09-03 11:25:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Indent <since> tags.

Browse Source 
Also updates the 'since' of applications/functions that existed before
XML documentation was introduced (1.6.2.0).

(cherry picked from commit b4156fecf0)
This commit is contained in:
Sean Bright
2025-01-23 16:35:58 -05:00
committed by Asterisk Development Team
parent 6d37b56fee
commit 3f15501335
210 changed files with 4020 additions and 1208 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
res/res_pjsip_outbound_publish.c
View File

@@ -47,7 +47,9 @@
</description>
<configFile name="pjsip.conf">
<configObject name="outbound-publish">
<since><version>13.0.0</version></since>
<since>
<version>13.0.0</version>
</since>
<synopsis>The configuration for outbound publish</synopsis>
<description><para>
Publish is <emphasis>COMPLETELY</emphasis> separate from the rest of
@@ -55,11 +57,15 @@
setting a <literal>server_uri</literal> and <literal>event</literal>.
</para></description>
<configOption name="expiration" default="3600">
<since><version>13.0.0</version></since>
<since>
<version>13.0.0</version>
</since>
<synopsis>Expiration time for publications in seconds</synopsis>
</configOption>
<configOption name="outbound_auth" default="">
<since><version>13.0.0</version></since>
<since>
<version>13.0.0</version>
</since>
<synopsis>Authentication object(s) to be used for outbound publishes.</synopsis>
<description><para>
This is a comma-delimited list of <replaceable>auth</replaceable>
@@ -74,11 +80,15 @@
</description>
</configOption>
<configOption name="outbound_proxy" default="">
<since><version>13.0.0</version></since>
<since>
<version>13.0.0</version>
</since>
<synopsis>Full SIP URI of the outbound proxy used to send publishes</synopsis>
</configOption>
<configOption name="server_uri">
<since><version>13.0.0</version></since>
<since>
<version>13.0.0</version>
</since>
<synopsis>SIP URI of the server and entity to publish to</synopsis>
<description><para>
This is the URI at which to find the entity and server to send the outbound PUBLISH to.
@@ -86,7 +96,9 @@
</para></description>
</configOption>
<configOption name="from_uri">
<since><version>13.0.0</version></since>
<since>
<version>13.0.0</version>
</since>
<synopsis>SIP URI to use in the From header</synopsis>
<description><para>
This is the URI that will be placed into the From header of outgoing PUBLISH
@@ -95,7 +107,9 @@
</para></description>
</configOption>
<configOption name="to_uri">
<since><version>13.0.0</version></since>
<since>
<version>13.0.0</version>
</since>
<synopsis>SIP URI to use in the To header</synopsis>
<description><para>
This is the URI that will be placed into the To header of outgoing PUBLISH
@@ -104,15 +118,21 @@
</para></description>
</configOption>
<configOption name="event" default="">
<since><version>13.0.0</version></since>
<since>
<version>13.0.0</version>
</since>
<synopsis>Event type of the PUBLISH.</synopsis>
</configOption>
<configOption name="max_auth_attempts" default="5">
<since><version>13.0.0</version></since>
<since>
<version>13.0.0</version>
</since>
<synopsis>Maximum number of authentication attempts before stopping the publication.</synopsis>
</configOption>
<configOption name="transport">
<since><version>13.9.0</version></since>
<since>
<version>13.9.0</version>
</since>
<synopsis>Transport used for outbound publish</synopsis>
<description>
<note><para>A <replaceable>transport</replaceable> configured in
@@ -120,12 +140,16 @@
</description>
</configOption>
<configOption name="multi_user" default="no">
<since><version>14.0.0</version></since>
<since>
<version>14.0.0</version>
</since>
<synopsis>Enable multi-user support</synopsis>
<description><para>When enabled the user portion of the server uri is replaced by a dynamically created user</para></description>
</configOption>
<configOption name="type">
<since><version>13.0.0</version></since>
<since>
<version>13.0.0</version>
</since>
<synopsis>Must be of type 'outbound-publish'.</synopsis>
</configOption>
</configObject>