res_pjsip_outbound_registration: Extend documentation for "max_retries".

If the "max_retries" option is set to 0 then upon failure no
further attemps are made, so explicitly document the behavior.

ASTERISK-28602

Change-Id: I1e30daae9dd6c49ce18744164214d3def505acbf

diff --git a/res/res_pjsip_outbound_registration.c b/res/res_pjsip_outbound_registration.c
index efeae23c03f91a4cbe891943b91a4ce4c49b1c21..fc52e9e284dd091c09d21f57a5de3cd03964e2f7 100644 (file)
--- a/res/res_pjsip_outbound_registration.c
+++ b/res/res_pjsip_outbound_registration.c
@@ -81,6 +81,11 @@
                                </configOption>
                                <configOption name="max_retries" default="10">
                                        <synopsis>Maximum number of registration attempts.</synopsis>
+                                       <description><para>
+                                               This sets the maximum number of registration attempts that are made before
+                                               stopping any further attempts. If set to 0 then upon failure no further attempts
+                                               are made.
+                                       </para></description>
                                </configOption>
                                <configOption name="outbound_auth" default="">
                                        <synopsis>Authentication object(s) to be used for outbound registrations.</synopsis>