noahbackus/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 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

141
doc/classes/ArrayMesh.xml
View File

@@ -51,28 +51,20 @@
</tutorials>
<methods>
<method name="add_blend_shape">
<return type="void">
</return>
<argument index="0" name="name" type="StringName">
</argument>
<return type="void" />
<argument index="0" name="name" type="StringName" />
<description>
Adds name for a blend shape that will be added with [method add_surface_from_arrays]. Must be called before surface is added.
</description>
</method>
<method name="add_surface_from_arrays">
<return type="void">
</return>
<argument index="0" name="primitive" type="int" enum="Mesh.PrimitiveType">
</argument>
<argument index="1" name="arrays" type="Array">
</argument>
<argument index="2" name="blend_shapes" type="Array" default="[]">
</argument>
<return type="void" />
<argument index="0" name="primitive" type="int" enum="Mesh.PrimitiveType" />
<argument index="1" name="arrays" type="Array" />
<argument index="2" name="blend_shapes" type="Array" default="[]" />
<argument index="3" name="lods" type="Dictionary" default="{
}">
</argument>
<argument index="4" name="compress_flags" type="int" default="0">
</argument>
}" />
<argument index="4" name="compress_flags" type="int" default="0" />
<description>
Creates a new surface.
Surfaces are created to be rendered using a [code]primitive[/code], which may be any of the types defined in [enum Mesh.PrimitiveType]. (As a note, when using indices, it is recommended to only use points, lines, or triangles.) [method Mesh.get_surface_count] will become the [code]surf_idx[/code] for this new surface.
@@ -80,161 +72,122 @@
</description>
</method>
<method name="clear_blend_shapes">
<return type="void">
</return>
<return type="void" />
<description>
Removes all blend shapes from this [ArrayMesh].
</description>
</method>
<method name="clear_surfaces">
<return type="void">
</return>
<return type="void" />
<description>
Removes all surfaces from this [ArrayMesh].
</description>
</method>
<method name="get_blend_shape_count" qualifiers="const">
<return type="int">
</return>
<return type="int" />
<description>
Returns the number of blend shapes that the [ArrayMesh] holds.
</description>
</method>
<method name="get_blend_shape_name" qualifiers="const">
<return type="StringName">
</return>
<argument index="0" name="index" type="int">
</argument>
<return type="StringName" />
<argument index="0" name="index" type="int" />
<description>
Returns the name of the blend shape at this index.
</description>
</method>
<method name="lightmap_unwrap">
<return type="int" enum="Error">
</return>
<argument index="0" name="transform" type="Transform3D">
</argument>
<argument index="1" name="texel_size" type="float">
</argument>
<return type="int" enum="Error" />
<argument index="0" name="transform" type="Transform3D" />
<argument index="1" name="texel_size" type="float" />
<description>
Will perform a UV unwrap on the [ArrayMesh] to prepare the mesh for lightmapping.
</description>
</method>
<method name="regen_normal_maps">
<return type="void">
</return>
<return type="void" />
<description>
Will regenerate normal maps for the [ArrayMesh].
</description>
</method>
<method name="set_blend_shape_name">
<return type="void">
</return>
<argument index="0" name="index" type="int">
</argument>
<argument index="1" name="name" type="StringName">
</argument>
<return type="void" />
<argument index="0" name="index" type="int" />
<argument index="1" name="name" type="StringName" />
<description>
</description>
</method>
<method name="surface_find_by_name" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="name" type="String">
</argument>
<return type="int" />
<argument index="0" name="name" type="String" />
<description>
Returns the index of the first surface with this name held within this [ArrayMesh]. If none are found, -1 is returned.
</description>
</method>
<method name="surface_get_array_index_len" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="surf_idx" type="int">
</argument>
<return type="int" />
<argument index="0" name="surf_idx" type="int" />
<description>
Returns the length in indices of the index array in the requested surface (see [method add_surface_from_arrays]).
</description>
</method>
<method name="surface_get_array_len" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="surf_idx" type="int">
</argument>
<return type="int" />
<argument index="0" name="surf_idx" type="int" />
<description>
Returns the length in vertices of the vertex array in the requested surface (see [method add_surface_from_arrays]).
</description>
</method>
<method name="surface_get_format" qualifiers="const">
<return type="int">
</return>
<argument index="0" name="surf_idx" type="int">
</argument>
<return type="int" />
<argument index="0" name="surf_idx" type="int" />
<description>
Returns the format mask of the requested surface (see [method add_surface_from_arrays]).
</description>
</method>
<method name="surface_get_name" qualifiers="const">
<return type="String">
</return>
<argument index="0" name="surf_idx" type="int">
</argument>
<return type="String" />
<argument index="0" name="surf_idx" type="int" />
<description>
Gets the name assigned to this surface.
</description>
</method>
<method name="surface_get_primitive_type" qualifiers="const">
<return type="int" enum="Mesh.PrimitiveType">
</return>
<argument index="0" name="surf_idx" type="int">
</argument>
<return type="int" enum="Mesh.PrimitiveType" />
<argument index="0" name="surf_idx" type="int" />
<description>
Returns the primitive type of the requested surface (see [method add_surface_from_arrays]).
</description>
</method>
<method name="surface_set_name">
<return type="void">
</return>
<argument index="0" name="surf_idx" type="int">
</argument>
<argument index="1" name="name" type="String">
</argument>
<return type="void" />
<argument index="0" name="surf_idx" type="int" />
<argument index="1" name="name" type="String" />
<description>
Sets a name for a given surface.
</description>
</method>
<method name="surface_update_attribute_region">
<return type="void">
</return>
<argument index="0" name="surf_idx" type="int">
</argument>
<argument index="1" name="offset" type="int">
</argument>
<argument index="2" name="data" type="PackedByteArray">
</argument>
<return type="void" />
<argument index="0" name="surf_idx" type="int" />
<argument index="1" name="offset" type="int" />
<argument index="2" name="data" type="PackedByteArray" />
<description>
</description>
</method>
<method name="surface_update_skin_region">
<return type="void">
</return>
<argument index="0" name="surf_idx" type="int">
</argument>
<argument index="1" name="offset" type="int">
</argument>
<argument index="2" name="data" type="PackedByteArray">
</argument>
<return type="void" />
<argument index="0" name="surf_idx" type="int" />
<argument index="1" name="offset" type="int" />
<argument index="2" name="data" type="PackedByteArray" />
<description>
</description>
</method>
<method name="surface_update_vertex_region">
<return type="void">
</return>
<argument index="0" name="surf_idx" type="int">
</argument>
<argument index="1" name="offset" type="int">
</argument>
<argument index="2" name="data" type="PackedByteArray">
</argument>
<return type="void" />
<argument index="0" name="surf_idx" type="int" />
<argument index="1" name="offset" type="int" />
<argument index="2" name="data" type="PackedByteArray" />
<description>
</description>
</method>