Skip to content

Commit 335c69e

Browse files
InterLinked1Friendly Automation
authored and
Friendly Automation
committed
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
1 parent c9ef2b3 commit 335c69e

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

main/cdr.c

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -90,18 +90,18 @@
9090
of use when debugging CDR behavior.</para>
9191
</description>
9292
</configOption>
93-
<configOption name="enable">
93+
<configOption name="enable" default="yes">
9494
<synopsis>Enable/disable CDR logging.</synopsis>
9595
<description><para>Define whether or not to use CDR logging. Setting this to "no" will override
96-
any loading of backend CDR modules. Default is "yes".</para>
96+
any loading of backend CDR modules.</para>
9797
</description>
9898
</configOption>
99-
<configOption name="channeldefaultenabled">
99+
<configOption name="channeldefaultenabled" default="yes">
100100
<synopsis>Whether CDR is enabled on a channel by default</synopsis>
101101
<description><para>Define whether or not CDR should be enabled on a channel by default.
102102
Setting this to "yes" will enable CDR on every channel unless it is explicitly disabled.
103103
Setting this to "no" will disable CDR on every channel unless it is explicitly enabled.
104-
Default is "yes".</para>
104+
</para>
105105
<para>Note that CDR must still be globally enabled (<literal>enable = yes</literal>) for this
106106
option to have any effect. This only applies to whether CDR is enabled or disabled on
107107
newly created channels, which can be changed in the dialplan during a call.</para>

res/res_ari.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,12 +96,12 @@
9696
<ref type="link">https://wiki.asterisk.org/wiki/display/AST/Asterisk+Builtin+mini-HTTP+Server</ref>
9797
</see-also>
9898
</configOption>
99-
<configOption name="websocket_write_timeout">
99+
<configOption name="websocket_write_timeout" default="100">
100100
<synopsis>The timeout (in milliseconds) to set on WebSocket connections.</synopsis>
101101
<description>
102102
<para>If a websocket connection accepts input slowly, the timeout
103103
for writes to it can be increased to keep it from being disconnected.
104-
Value is in milliseconds; default is 100 ms.</para>
104+
Value is in milliseconds.</para>
105105
</description>
106106
</configOption>
107107
<configOption name="pretty">

res/res_pjsip.c

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1795,12 +1795,12 @@
17951795
or the <replaceable>wss</replaceable> protocols.</para></note>
17961796
</description>
17971797
</configOption>
1798-
<configOption name="websocket_write_timeout">
1798+
<configOption name="websocket_write_timeout" default="100">
17991799
<synopsis>The timeout (in milliseconds) to set on WebSocket connections.</synopsis>
18001800
<description>
18011801
<para>If a websocket connection accepts input slowly, the timeout
18021802
for writes to it can be increased to keep it from being disconnected.
1803-
Value is in milliseconds; default is 100 ms.</para>
1803+
Value is in milliseconds.</para>
18041804
</description>
18051805
</configOption>
18061806
<configOption name="allow_reload" default="no">

0 commit comments

Comments
 (0)