[Asterisk-code-review] documentation: Adds missing default attributes. (asterisk[18])

[N A]

N A has uploaded this change for review. ( https://gerrit.asterisk.org/c/asterisk/+/18039 )


Change subject: documentation: Adds missing default attributes.
......................................................................

documentation: Adds missing default attributes.

The configObject tag contains a default attribute which
allows the default value to be specified, if applicable.
This allows for the default value to show up specially on
the wiki in a way that is clear to users.

There are a couple places in the tree where default values
are included in the description as opposed to as attributes,
which means these can't be parsed specially for the wiki.
These are changed to use the attribute instead of being
included in the text description.

ASTERISK-29898 #close

Change-Id: I9d7ea08f50075f41459ea7b76654906b674ec755
---
M main/cdr.c
M res/res_ari.c
M res/res_pjsip.c
3 files changed, 8 insertions(+), 8 deletions(-)



  git pull ssh://gerrit.asterisk.org:29418/asterisk refs/changes/39/18039/1

diff --git a/main/cdr.c b/main/cdr.c
index 8a3ad66..b059082 100644
--- a/main/cdr.c
+++ b/main/cdr.c
@@ -90,18 +90,18 @@
 					of use when debugging CDR behavior.</para>
 					</description>
 				</configOption>
-				<configOption name="enable">
+				<configOption name="enable" default="yes">
 					<synopsis>Enable/disable CDR logging.</synopsis>
 					<description><para>Define whether or not to use CDR logging. Setting this to "no" will override
-					any loading of backend CDR modules.  Default is "yes".</para>
+					any loading of backend CDR modules.</para>
 					</description>
 				</configOption>
-				<configOption name="channeldefaultenabled">
+				<configOption name="channeldefaultenabled" default="yes">
 					<synopsis>Whether CDR is enabled on a channel by default</synopsis>
 					<description><para>Define whether or not CDR should be enabled on a channel by default.
 					Setting this to "yes" will enable CDR on every channel unless it is explicitly disabled.
 					Setting this to "no" will disable CDR on every channel unless it is explicitly enabled.
-					Default is "yes".</para>
+					</para>
 					<para>Note that CDR must still be globally enabled (<literal>enable = yes</literal>) for this
 					option to have any effect. This only applies to whether CDR is enabled or disabled on
 					newly created channels, which can be changed in the dialplan during a call.</para>
diff --git a/res/res_ari.c b/res/res_ari.c
index e8d1fee..025fa90 100644
--- a/res/res_ari.c
+++ b/res/res_ari.c
@@ -96,12 +96,12 @@
 						<ref type="link">https://wiki.asterisk.org/wiki/display/AST/Asterisk+Builtin+mini-HTTP+Server</ref>
 					</see-also>
 				</configOption>
-				<configOption name="websocket_write_timeout">
+				<configOption name="websocket_write_timeout" default="100">
 					<synopsis>The timeout (in milliseconds) to set on WebSocket connections.</synopsis>
 					<description>
 						<para>If a websocket connection accepts input slowly, the timeout
 						for writes to it can be increased to keep it from being disconnected.
-						Value is in milliseconds; default is 100 ms.</para>
+						Value is in milliseconds.</para>
 					</description>
 				</configOption>
 				<configOption name="pretty">
diff --git a/res/res_pjsip.c b/res/res_pjsip.c
index 0ef2030..3d1f68c 100644
--- a/res/res_pjsip.c
+++ b/res/res_pjsip.c
@@ -1795,12 +1795,12 @@
 					or the <replaceable>wss</replaceable> protocols.</para></note>
 					</description>
 				</configOption>
-				<configOption name="websocket_write_timeout">
+				<configOption name="websocket_write_timeout" default="100">
 					<synopsis>The timeout (in milliseconds) to set on WebSocket connections.</synopsis>
 					<description>
 						<para>If a websocket connection accepts input slowly, the timeout
 						for writes to it can be increased to keep it from being disconnected.
-						Value is in milliseconds; default is 100 ms.</para>
+						Value is in milliseconds.</para>
 					</description>
 				</configOption>
 				<configOption name="allow_reload" default="no">

-- 
To view, visit https://gerrit.asterisk.org/c/asterisk/+/18039
To unsubscribe, or for help writing mail filters, visit https://gerrit.asterisk.org/settings

Gerrit-Project: asterisk
Gerrit-Branch: 18
Gerrit-Change-Id: I9d7ea08f50075f41459ea7b76654906b674ec755
Gerrit-Change-Number: 18039
Gerrit-PatchSet: 1
Gerrit-Owner: N A <mail at interlinked.x10host.com>
Gerrit-MessageType: newchange
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-code-review/attachments/20220217/f95a7a78/attachment-0001.html>