seedlingattempt/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: Use self-closing tags for return and argument

Browse Source 
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.
This commit is contained in:
Rémi Verschelde
2021-07-30 15:28:05 +02:00
parent a1c19b9a1e
commit 7adf4cc9b5
408 changed files with 14025 additions and 28050 deletions
Download Patch File Download Diff File Expand all files Collapse all files

90
doc/classes/AudioEffectChorus.xml
View File

@ -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>