diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2021-07-30 15:28:05 +0200 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2021-07-30 15:29:52 +0200 |
| commit | 7adf4cc9b5de6701a41e27690a69b9892d5eed85 (patch) | |
| tree | 0019e6d1b7cd993b81d5bba268074cfc4e10a213 /doc/classes/AudioEffectChorus.xml | |
| parent | a1c19b9a1e53f78c75c13cb418270db80057b21a (diff) | |
doc: Use self-closing tags for `return` and `argument`
For the time being we don't support writing a description for those, preferring
having all details in the method's description.
Using self-closing tags saves half the lines, and prevents contributors from
thinking that they should write the argument or return documentation there.
Diffstat (limited to 'doc/classes/AudioEffectChorus.xml')
| -rw-r--r-- | doc/classes/AudioEffectChorus.xml | 90 |
1 files changed, 30 insertions, 60 deletions
diff --git a/doc/classes/AudioEffectChorus.xml b/doc/classes/AudioEffectChorus.xml index 30913a1529..cc93a8fc03 100644 --- a/doc/classes/AudioEffectChorus.xml +++ b/doc/classes/AudioEffectChorus.xml @@ -10,110 +10,80 @@ </tutorials> <methods> <method name="get_voice_cutoff_hz" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="voice_idx" type="int"> - </argument> + <return type="float" /> + <argument index="0" name="voice_idx" type="int" /> <description> </description> </method> <method name="get_voice_delay_ms" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="voice_idx" type="int"> - </argument> + <return type="float" /> + <argument index="0" name="voice_idx" type="int" /> <description> </description> </method> <method name="get_voice_depth_ms" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="voice_idx" type="int"> - </argument> + <return type="float" /> + <argument index="0" name="voice_idx" type="int" /> <description> </description> </method> <method name="get_voice_level_db" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="voice_idx" type="int"> - </argument> + <return type="float" /> + <argument index="0" name="voice_idx" type="int" /> <description> </description> </method> <method name="get_voice_pan" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="voice_idx" type="int"> - </argument> + <return type="float" /> + <argument index="0" name="voice_idx" type="int" /> <description> </description> </method> <method name="get_voice_rate_hz" qualifiers="const"> - <return type="float"> - </return> - <argument index="0" name="voice_idx" type="int"> - </argument> + <return type="float" /> + <argument index="0" name="voice_idx" type="int" /> <description> </description> </method> <method name="set_voice_cutoff_hz"> - <return type="void"> - </return> - <argument index="0" name="voice_idx" type="int"> - </argument> - <argument index="1" name="cutoff_hz" type="float"> - </argument> + <return type="void" /> + <argument index="0" name="voice_idx" type="int" /> + <argument index="1" name="cutoff_hz" type="float" /> <description> </description> </method> <method name="set_voice_delay_ms"> - <return type="void"> - </return> - <argument index="0" name="voice_idx" type="int"> - </argument> - <argument index="1" name="delay_ms" type="float"> - </argument> + <return type="void" /> + <argument index="0" name="voice_idx" type="int" /> + <argument index="1" name="delay_ms" type="float" /> <description> </description> </method> <method name="set_voice_depth_ms"> - <return type="void"> - </return> - <argument index="0" name="voice_idx" type="int"> - </argument> - <argument index="1" name="depth_ms" type="float"> - </argument> + <return type="void" /> + <argument index="0" name="voice_idx" type="int" /> + <argument index="1" name="depth_ms" type="float" /> <description> </description> </method> <method name="set_voice_level_db"> - <return type="void"> - </return> - <argument index="0" name="voice_idx" type="int"> - </argument> - <argument index="1" name="level_db" type="float"> - </argument> + <return type="void" /> + <argument index="0" name="voice_idx" type="int" /> + <argument index="1" name="level_db" type="float" /> <description> </description> </method> <method name="set_voice_pan"> - <return type="void"> - </return> - <argument index="0" name="voice_idx" type="int"> - </argument> - <argument index="1" name="pan" type="float"> - </argument> + <return type="void" /> + <argument index="0" name="voice_idx" type="int" /> + <argument index="1" name="pan" type="float" /> <description> </description> </method> <method name="set_voice_rate_hz"> - <return type="void"> - </return> - <argument index="0" name="voice_idx" type="int"> - </argument> - <argument index="1" name="rate_hz" type="float"> - </argument> + <return type="void" /> + <argument index="0" name="voice_idx" type="int" /> + <argument index="1" name="rate_hz" type="float" /> <description> </description> </method> |