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/AudioStreamSample.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/AudioStreamSample.xml')
| -rw-r--r-- | doc/classes/AudioStreamSample.xml | 6 |
1 files changed, 2 insertions, 4 deletions
diff --git a/doc/classes/AudioStreamSample.xml b/doc/classes/AudioStreamSample.xml index 5a0e71a0f8..7e1155d89b 100644 --- a/doc/classes/AudioStreamSample.xml +++ b/doc/classes/AudioStreamSample.xml @@ -11,10 +11,8 @@ </tutorials> <methods> <method name="save_to_wav"> - <return type="int" enum="Error"> - </return> - <argument index="0" name="path" type="String"> - </argument> + <return type="int" enum="Error" /> + <argument index="0" name="path" type="String" /> <description> Saves the AudioStreamSample as a WAV file to [code]path[/code]. Samples with IMA ADPCM format can't be saved. [b]Note:[/b] A [code].wav[/code] extension is automatically appended to [code]path[/code] if it is missing. |