]> git.ipfire.org Git - thirdparty/asterisk.git/commitdiff
res_agi: Fix xmldocs bug with set music.
authorNaveen Albert <asterisk@phreaknet.org>
Fri, 25 Feb 2022 17:01:41 +0000 (17:01 +0000)
committerFriendly Automation <jenkins2@gerrit.asterisk.org>
Fri, 25 Mar 2022 23:27:29 +0000 (18:27 -0500)
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
(cherry picked from commit 37ece75677bff5655f0a3fb4dbda2b7c4847bc50)

res/res_agi.c

index 56fef9b9611cece750a66ff62442329dd4bab4f6..af85445482c77ed082d23fef104e03d8885f6743 100644 (file)
                        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" />