From fdfe1ea82e49f006d3ba630d237e22cf65ab47aa Mon Sep 17 00:00:00 2001 From: Rusty Newton <rnewton@digium.com> Date: Sat, 17 Aug 2013 17:40:34 +0000 Subject: [PATCH] xml doc changes for clarity - 'auth' config object and auth's 'auth_type' config option (issue ASTERISK-22108) (closes issue ASTERISK-22108) git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@396900 65c4cc65-6c06-0410-ace0-fbb531ad65f3 --- res/res_pjsip.c | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/res/res_pjsip.c b/res/res_pjsip.c index 27d4462968..44b45ba411 100644 --- a/res/res_pjsip.c +++ b/res/res_pjsip.c @@ -623,16 +623,18 @@ <configObject name="auth"> <synopsis>Authentication type</synopsis> <description><para> - Authentication objects hold the authenitcation information for use - by <literal>endpoints</literal>. This also allows for multiple <literal> - endpoints</literal> to use the same information. Choice of MD5/plaintext - and setting of username. + Authentication objects hold the authentication information for use + by other objects such as <literal>endpoints</literal> or <literal>registrations</literal>. + This also allows for multiple objects to use a single auth object. See + the <literal>auth_type</literal> config option for password style choices. </para></description> <configOption name="auth_type" default="userpass"> <synopsis>Authentication type</synopsis> <description><para> - This option specifies which of the password style config options should be read, - either 'password' or 'md5_cred' when trying to authenticate an endpoint inbound request. + This option specifies which of the password style config options should be read + when trying to authenticate an endpoint inbound request. If set to <literal>userpass</literal> + then we'll read from the 'password' option. For <literal>md5</literal> we'll read + from 'md5_cred'. </para> <enumlist> <enum name="md5"/> -- GitLab