[doc] Use "param" instead of "code" to refer to parameters #3

This commit is contained in:
Andy Maloney
2022-08-09 22:00:19 -04:00
parent 317ced8204
commit 1f72f48361
50 changed files with 362 additions and 362 deletions

View File

@@ -22,7 +22,7 @@
<return type="void" />
<param index="0" name="mod_idx" type="int" />
<description>
Deletes the [SkeletonModification2D] at the index position [code]mod_idx[/code], if it exists.
Deletes the [SkeletonModification2D] at the index position [param mod_idx], if it exists.
</description>
</method>
<method name="enable_all_modifications">
@@ -37,7 +37,7 @@
<param index="0" name="delta" type="float" />
<param index="1" name="execution_mode" type="int" />
<description>
Executes all of the [SkeletonModification2D]s in the stack that use the same execution mode as the passed-in [code]execution_mode[/code], starting from index [code]0[/code] to [member modification_count].
Executes all of the [SkeletonModification2D]s in the stack that use the same execution mode as the passed-in [param execution_mode], starting from index [code]0[/code] to [member modification_count].
[b]Note:[/b] The order of the modifications can matter depending on the modifications. For example, modifications on a spine should operate before modifications on the arms in order to get proper results.
</description>
</method>
@@ -51,7 +51,7 @@
<return type="SkeletonModification2D" />
<param index="0" name="mod_idx" type="int" />
<description>
Returns the [SkeletonModification2D] at the passed-in index, [code]mod_idx[/code].
Returns the [SkeletonModification2D] at the passed-in index, [param mod_idx].
</description>
</method>
<method name="get_skeleton" qualifiers="const">
@@ -65,7 +65,7 @@
<param index="0" name="mod_idx" type="int" />
<param index="1" name="modification" type="SkeletonModification2D" />
<description>
Sets the modification at [code]mod_idx[/code] to the passed-in modification, [code]modification[/code].
Sets the modification at [param mod_idx] to the passed-in modification, [param modification].
</description>
</method>
<method name="setup">