[asterisk-commits] newtonr: branch 12 r406133 - /branches/12/res/res_pjsip.c

[SVN commits to the Asterisk project]

Author: newtonr
Date: Tue Jan 21 15:47:13 2014
New Revision: 406133

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=406133
Log:
res_pjsip: Documentation improvement for Endpoint and AOR mailbox options.

Making the help text for both more explicit regarding the format of mailbox identifiers. i.e. clarifying the format for app_voicemail mailboxes vs mailboxes from external MWI sources through modules such as res_external_mwi.

Modified:
    branches/12/res/res_pjsip.c

Modified: branches/12/res/res_pjsip.c
URL: http://svnview.digium.com/svn/asterisk/branches/12/res/res_pjsip.c?view=diff&rev=406133&r1=406132&r2=406133
==============================================================================
--- branches/12/res/res_pjsip.c (original)
+++ branches/12/res/res_pjsip.c Tue Jan 21 15:47:13 2014
@@ -270,9 +270,12 @@
 					<description><para>
 						Asterisk will send unsolicited MWI NOTIFY messages to the endpoint when state
 						changes happen for any of the specified mailboxes. More than one mailbox can be
-						specified with a comma-delimited string. Mailboxes must be specified as mailbox at context;
-						for example: mailboxes=6001 at default.
-						For endpoints that SUBSCRIBE for MWI, you can set the <literal>mailboxes</literal> option in your AOR
+						specified with a comma-delimited string. app_voicemail mailboxes must be specified
+						as mailbox at context; for example: mailboxes=6001 at default. For mailboxes provided by
+						external sources, such as through the res_external_mwi module, you must specify
+						strings supported by the external system.
+					</para><para>
+						For endpoints that SUBSCRIBE for MWI, use the <literal>mailboxes</literal> option in your AOR
 						configuration.
 					</para></description>
 				</configOption>
@@ -930,12 +933,17 @@
 					<synopsis>Default expiration time in seconds for contacts that are dynamically bound to an AoR.</synopsis>
 				</configOption>
 				<configOption name="mailboxes">
-					<synopsis>Mailbox(es) to be associated with</synopsis>
+					<synopsis>Allow subscriptions for the specified mailbox(es)</synopsis>
 					<description><para>This option applies when an external entity subscribes to an AoR
-					for message waiting indications. The mailboxes specified will be subscribed to.
-					More than one mailbox can be specified with a comma-delimited string.
-					For endpoints that cannot SUBSCRIBE for MWI, you can set the <literal>mailboxes</literal> option in your
-					Endpoint configuration section.
+						for Message Waiting Indications. The mailboxes specified will be subscribed to.
+						More than one mailbox can be specified with a comma-delimited string.
+						app_voicemail mailboxes must be specified as mailbox at context;
+						for example: mailboxes=6001 at default. For mailboxes provided by external sources,
+						such as through the res_external_mwi module, you must specify strings supported by
+						the external system.
+					</para><para>
+						For endpoints that cannot SUBSCRIBE for MWI, you can set the <literal>mailboxes</literal> option in your
+						endpoint configuration section to enable unsolicited MWI NOTIFYs to the endpoint.
 					</para></description>
 				</configOption>
 				<configOption name="maximum_expiration" default="7200">