diff options
| author | Matthew Jordan <mjordan@digium.com> | 2013-08-23 15:21:40 +0000 |
|---|---|---|
| committer | Matthew Jordan <mjordan@digium.com> | 2013-08-23 15:21:40 +0000 |
| commit | e31bd332b83f0245ce8bd6626279e1b9c683ec18 (patch) | |
| tree | f6ce4f0257399a167527b6dd02fda9339d323214 /res/res_pjsip.c | |
| parent | b2a13e83dcb4958cccd5d314a1bb8bf25379cb51 (diff) | |
Update config framework/sorcery with types/options without documentation
There are times when a configuration option should not have documentation.
1. Some options are registered with a particular object merely as a warning to
users. These options aren't even really 'deprecated' - which has its own
separate API call - they are actually provided by a different configuration
file. The options are merely registered so that the user gets a warning that
a different configuration file provides the item.
2. Some object types - most notably some used by modules that use sorcery - are
completely internal and should never be shown to the user.
3. Sorcery itself has several 'hidden' fields that should never be shown to a
user.
This patch updates the configuration framework and sorcery with additional API
calls that allow a module to register types as internal and options as not
requiring documentation. This bypasses the XML documentation checking.
This patch also re-enables the strict XML documentation checking in trunk, as
well as updates some documentation that was missing.
Review: https://reviewboard.asterisk.org/r/2785/
(closes issue ASTERISK-22359)
Reported by: Matt Jordan
(closes issue ASTERISK-22112)
Reported by: Rusty Newton
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@397524 65c4cc65-6c06-0410-ace0-fbb531ad65f3
Diffstat (limited to 'res/res_pjsip.c')
| -rw-r--r-- | res/res_pjsip.c | 63 |
1 files changed, 28 insertions, 35 deletions
diff --git a/res/res_pjsip.c b/res/res_pjsip.c index 9b5727fb5..1e5d25705 100644 --- a/res/res_pjsip.c +++ b/res/res_pjsip.c @@ -256,6 +256,10 @@ <configOption name="rtp_symmetric" default="no"> <synopsis>Enforce that RTP must be symmetric</synopsis> </configOption> + <configOption name="send_diversion" default="yes"> + <synopsis>Send the Diversion header, conveying the diversion + information to the called user agent</synopsis> + </configOption> <configOption name="send_pai" default="no"> <synopsis>Send the P-Asserted-Identity header</synopsis> </configOption> @@ -670,15 +674,6 @@ <synopsis>Username to use for account</synopsis> </configOption> </configObject> - <configObject name="nat_hook"> - <synopsis>XXX This exists only to prevent XML documentation errors.</synopsis> - <configOption name="external_media_address"> - <synopsis>I should be undocumented or hidden</synopsis> - </configOption> - <configOption name="method"> - <synopsis>I should be undocumented or hidden</synopsis> - </configOption> - </configObject> <configObject name="domain_alias"> <synopsis>Domain Alias</synopsis> <description><para> @@ -769,6 +764,8 @@ <enum name="udp" /> <enum name="tcp" /> <enum name="tls" /> + <enum name="ws" /> + <enum name="wss" /> </enumlist> </description> </configOption> @@ -784,6 +781,24 @@ <configOption name="verify_server" default="false"> <synopsis>Require verification of server certificate (TLS ONLY)</synopsis> </configOption> + <configOption name="tos" default="false"> + <synopsis>Enable TOS for the signalling sent over this transport</synopsis> + <description> + <para>See <literal>https://wiki.asterisk.org/wiki/display/AST/IP+Quality+of+Service</literal> + for more information on this parameter.</para> + <note><para>This option does not apply to the <replaceable>ws</replaceable> + or the <replaceable>wss</replaceable> protocols.</para></note> + </description> + </configOption> + <configOption name="cos" default="false"> + <synopsis>Enable COS for the signalling sent over this transport</synopsis> + <description> + <para>See <literal>https://wiki.asterisk.org/wiki/display/AST/IP+Quality+of+Service</literal> + for more information on this parameter.</para> + <note><para>This option does not apply to the <replaceable>ws</replaceable> + or the <replaceable>wss</replaceable> protocols.</para></note> + </description> + </configOption> </configObject> <configObject name="contact"> <synopsis>A way of creating an aliased name to a SIP URI</synopsis> @@ -812,28 +827,6 @@ </para></description> </configOption> </configObject> - <configObject name="contact_status"> - <synopsis>Status for a contact</synopsis> - <description><para> - The contact status keeps track of whether or not a contact is reachable - and how long it took to qualify the contact (round trip time). - </para></description> - <configOption name="status"> - <synopsis>A contact's status</synopsis> - <description> - <enumlist> - <enum name="AVAILABLE" /> - <enum name="UNAVAILABLE" /> - </enumlist> - </description> - </configOption> - <configOption name="rtt"> - <synopsis>Round trip time</synopsis> - <description><para> - The time, in microseconds, it took to qualify the contact. - </para></description> - </configOption> - </configObject> <configObject name="aor"> <synopsis>The configuration for a location of an endpoint</synopsis> <description><para> @@ -972,7 +965,7 @@ A value of 0 indicates no maximum.</synopsis> </configOption> <configOption name="type"> - <synopsis>Must be of type 'system'.</synopsis> + <synopsis>Must be of type 'system'.</synopsis> </configOption> </configObject> <configObject name="global"> @@ -984,12 +977,12 @@ <configOption name="maxforwards" default="70"> <synopsis>Value used in Max-Forwards header for SIP requests.</synopsis> </configOption> + <configOption name="type"> + <synopsis>Must be of type 'global'.</synopsis> + </configOption> <configOption name="useragent" default="Asterisk <Asterisk Version>"> <synopsis>Value used in User-Agent header for SIP requests and Server header for SIP responses.</synopsis> </configOption> - <configOption name="type"> - <synopsis>Must be of type 'global'.</synopsis> - </configOption> </configObject> </configFile> </configInfo> |