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

15
doc/classes/EditorTranslationParserPlugin.xml
View File

@@ -103,21 +103,16 @@
</tutorials>
<methods>
<method name="_get_recognized_extensions" qualifiers="virtual">
<return type="Array">
</return>
<return type="Array" />
<description>
Gets the list of file extensions to associate with this parser, e.g. [code]["csv"][/code].
</description>
</method>
<method name="_parse_file" qualifiers="virtual">
<return type="void">
</return>
<argument index="0" name="path" type="String">
</argument>
<argument index="1" name="msgids" type="Array">
</argument>
<argument index="2" name="msgids_context_plural" type="Array">
</argument>
<return type="void" />
<argument index="0" name="path" type="String" />
<argument index="1" name="msgids" type="Array" />
<argument index="2" name="msgids_context_plural" type="Array" />
<description>
Override this method to define a custom parsing logic to extract the translatable strings.
</description>