godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2026-01-03 18:11:19 +03:00
Code Issues Packages Projects Releases 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

30
doc/classes/EditorResourcePreviewGenerator.xml
View File

@@ -10,20 +10,16 @@
</tutorials>
<methods>
<method name="_can_generate_small_preview" qualifiers="virtual">
<return type="bool">
</return>
<return type="bool" />
<description>
If this function returns [code]true[/code], the generator will call [method _generate] or [method _generate_from_path] for small previews as well.
By default, it returns [code]false[/code].
</description>
</method>
<method name="_generate" qualifiers="virtual">
<return type="Texture2D">
</return>
<argument index="0" name="from" type="Resource">
</argument>
<argument index="1" name="size" type="Vector2">
</argument>
<return type="Texture2D" />
<argument index="0" name="from" type="Resource" />
<argument index="1" name="size" type="Vector2" />
<description>
Generate a preview from a given resource with the specified size. This must always be implemented.
Returning an empty texture is an OK way to fail and let another generator take care.
@@ -31,12 +27,9 @@
</description>
</method>
<method name="_generate_from_path" qualifiers="virtual">
<return type="Texture2D">
</return>
<argument index="0" name="path" type="String">
</argument>
<argument index="1" name="size" type="Vector2">
</argument>
<return type="Texture2D" />
<argument index="0" name="path" type="String" />
<argument index="1" name="size" type="Vector2" />
<description>
Generate a preview directly from a path with the specified size. Implementing this is optional, as default code will load and call [method _generate].
Returning an empty texture is an OK way to fail and let another generator take care.
@@ -44,18 +37,15 @@
</description>
</method>
<method name="_generate_small_preview_automatically" qualifiers="virtual">
<return type="bool">
</return>
<return type="bool" />
<description>
If this function returns [code]true[/code], the generator will automatically generate the small previews from the normal preview texture generated by the methods [method _generate] or [method _generate_from_path].
By default, it returns [code]false[/code].
</description>
</method>
<method name="_handles" qualifiers="virtual">
<return type="bool">
</return>
<argument index="0" name="type" type="String">
</argument>
<return type="bool" />
<argument index="0" name="type" type="String" />
<description>
Returns [code]true[/code] if your generator supports the resource of type [code]type[/code].
</description>