[Asterisk-code-review] res_agi: Fix xmldocs bug with set music. (asterisk[master])

Friendly Automation asteriskteam at digium.com
Mon Mar 14 10:27:13 CDT 2022


Friendly Automation has submitted this change. ( https://gerrit.asterisk.org/c/asterisk/+/18077 )

Change subject: res_agi: Fix xmldocs bug with set music.
......................................................................

res_agi: Fix xmldocs bug with set music.

The XML documentation for the SET MUSIC AGI
command is invalid, as the parameter does not
have a name and the on/off enum options for
the on/off argument are listed separately, which
is incorrect. The cumulative effect of these currently
is that the Asterisk Wiki documentation for SET MUSIC
is broken and external documentation generators crash
on SET MUSIC due to the malformed documentation.

These issues are corrected so that the documentation
can be successfully parsed as with other similar AGI
commands.

ASTERISK-29939 #close
ASTERISK-28891 #close

Change-Id: I8c3d59897531bcbc401cbc7b00c9e2829dcb35f8
---
M res/res_agi.c
1 file changed, 3 insertions(+), 7 deletions(-)

Approvals:
  Joshua Colp: Looks good to me, but someone else must approve
  Sean Bright: Looks good to me, approved
  Benjamin Keith Ford: Looks good to me, but someone else must approve
  Friendly Automation: Approved for Submit



diff --git a/res/res_agi.c b/res/res_agi.c
index 8bdb7ed..339a15d 100644
--- a/res/res_agi.c
+++ b/res/res_agi.c
@@ -794,14 +794,10 @@
 			Enable/Disable Music on hold generator
 		</synopsis>
 		<syntax>
-			<parameter required="true">
+			<parameter name="boolean" required="true">
 				<enumlist>
-					<enum>
-						<parameter name="on" literal="true" required="true" />
-					</enum>
-					<enum>
-						<parameter name="off" literal="true" required="true" />
-					</enum>
+					<enum name="on" />
+					<enum name="off" />
 				</enumlist>
 			</parameter>
 			<parameter name="class" required="true" />

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

Gerrit-Project: asterisk
Gerrit-Branch: master
Gerrit-Change-Id: I8c3d59897531bcbc401cbc7b00c9e2829dcb35f8
Gerrit-Change-Number: 18077
Gerrit-PatchSet: 3
Gerrit-Owner: N A <mail at interlinked.x10host.com>
Gerrit-Reviewer: Benjamin Keith Ford <bford at digium.com>
Gerrit-Reviewer: Friendly Automation
Gerrit-Reviewer: Joshua Colp <jcolp at sangoma.com>
Gerrit-Reviewer: Sean Bright <sean at seanbright.com>
Gerrit-MessageType: merged
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-code-review/attachments/20220314/c58f9f5d/attachment.html>


More information about the asterisk-code-review mailing list