hertog/godot-module-template
Template
2
1
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[doc] Use "param" instead of "code" to refer to parameters (8)

Browse source
This commit is contained in:
Andy Maloney 2022-08-12 13:51:01 -04:00
parent cf1bb3d83a
commit 9b345e793a
28 changed files with 283 additions and 283 deletions
Download patch file Download diff file Expand all files Collapse all files

6
doc/classes/AudioEffectCapture.xml
View file

@ -15,7 +15,7 @@
<return type="bool" />
<param 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.
Returns [code]true[/code] if at least [param frames] audio frames are available to read in the internal ring buffer.
</description>
</method>
<method name="clear_buffer">
@ -28,8 +28,8 @@
<return type="PackedVector2Array" />
<param 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.
Gets the next [param frames] audio samples from the internal ring buffer.
Returns a [PackedVector2Array] containing exactly [param frames] audio samples if available, or an empty [PackedVector2Array] if insufficient data was available.
</description>
</method>
<method name="get_buffer_length_frames" qualifiers="const">