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/AudioEffectCapture.xml | |
| parent | a1c19b9a1e53f78c75c13cb418270db80057b21a (diff) | |
| download | redot-engine-7adf4cc9b5de6701a41e27690a69b9892d5eed85.tar.gz | |
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/AudioEffectCapture.xml')
| -rw-r--r-- | doc/classes/AudioEffectCapture.xml | 27 |
1 files changed, 9 insertions, 18 deletions
diff --git a/doc/classes/AudioEffectCapture.xml b/doc/classes/AudioEffectCapture.xml index c7ee621ca6..8e46acbd07 100644 --- a/doc/classes/AudioEffectCapture.xml +++ b/doc/classes/AudioEffectCapture.xml @@ -11,55 +11,46 @@ </tutorials> <methods> <method name="can_get_buffer" qualifiers="const"> - <return type="bool"> - </return> - <argument index="0" name="frames" type="int"> - </argument> + <return type="bool" /> + <argument index="0" name="frames" type="int" /> <description> Returns [code]true[/code] if at least [code]frames[/code] audio frames are available to read in the internal ring buffer. </description> </method> <method name="clear_buffer"> - <return type="void"> - </return> + <return type="void" /> <description> Clears the internal ring buffer. </description> </method> <method name="get_buffer"> - <return type="PackedVector2Array"> - </return> - <argument index="0" name="frames" type="int"> - </argument> + <return type="PackedVector2Array" /> + <argument index="0" name="frames" type="int" /> <description> Gets the next [code]frames[/code] audio samples from the internal ring buffer. Returns a [PackedVector2Array] containing exactly [code]frames[/code] audio samples if available, or an empty [PackedVector2Array] if insufficient data was available. </description> </method> <method name="get_buffer_length_frames" qualifiers="const"> - <return type="int"> - </return> + <return type="int" /> <description> Returns the total size of the internal ring buffer in frames. </description> </method> <method name="get_discarded_frames" qualifiers="const"> - <return type="int"> - </return> + <return type="int" /> <description> Returns the number of audio frames discarded from the audio bus due to full buffer. </description> </method> <method name="get_frames_available" qualifiers="const"> - <return type="int"> - </return> + <return type="int" /> <description> Returns the number of frames available to read using [method get_buffer]. </description> </method> <method name="get_pushed_frames" qualifiers="const"> - <return type="int"> - </return> + <return type="int" /> <description> Returns the number of audio frames inserted from the audio bus. </description> |