noahbackus/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

Proofread and improve the whole class reference

Browse Source 
- Document a few more properties and methods
- Add more information to many classes
- Fix lots of typos and gramar mistakes
- Use [code] tags for parameters consistently
- Use [b] and [i] tags consistently
- Put "Warning:" and "Note:" on their own line to be more visible,
  and make them always bold
- Tweak formatting in code examples to be more readable
- Use double quotes consistently
- Add more links to third-party technologies
This commit is contained in:
Hugo Locurcio
2019-06-22 01:04:47 +02:00
parent 538c8eec15
commit f7f6115f76
330 changed files with 2585 additions and 2474 deletions
Download Patch File Download Diff File Expand all files Collapse all files
doc/classes/EditorResourcePreviewGenerator.xml
+6 -6
View File
@@ -4,7 +4,7 @@
Custom generator of previews.
</brief_description>
<description>
Custom code to generate previews. Please check "file_dialog/thumbnail_size" in EditorSettings to find out the right size to do previews at.
Custom code to generate previews. Please check [code]file_dialog/thumbnail_size[/code] in [EditorSettings] to find out the right size to do previews at.
</description>
<tutorials>
</tutorials>
@@ -13,8 +13,8 @@
<return type="bool">
</return>
<description>
If this function returns true the generator will call [method generate] or [method generate_from_path] for small previews too.
By default it returns false.
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">
@@ -47,8 +47,8 @@
<return type="bool">
</return>
<description>
If this function returns true 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 false.
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">
@@ -57,7 +57,7 @@
<argument index="0" name="type" type="String">
</argument>
<description>
Returns if your generator supports this resource type.
Returns [code]true[/code] if your generator supports the resource of type [code]type[/code].
</description>
</method>
</methods>