godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-11-22 15:06:45 +00:00
Code 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.

(cherry picked from commit 7adf4cc9b5)
This commit is contained in:
Rémi Verschelde
2021-07-30 15:28:05 +02:00
parent a43365bd58
commit f5836b40d4
356 changed files with 10841 additions and 21682 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
doc/classes/JavaScript.xml
View File

@@ -12,34 +12,25 @@
</tutorials>
<methods>
<method name="create_callback">
<return type="JavaScriptObject">
</return>
<argument index="0" name="object" type="Object">
</argument>
<argument index="1" name="method" type="String">
</argument>
<return type="JavaScriptObject" />
<argument index="0" name="object" type="Object" />
<argument index="1" name="method" type="String" />
<description>
Creates a reference to a script function that can be used as a callback by JavaScript. The reference must be kept until the callback happens, or it won't be called at all. See [JavaScriptObject] for usage.
</description>
</method>
<method name="create_object" qualifiers="vararg">
<return type="Variant">
</return>
<argument index="0" name="object" type="String">
</argument>
<return type="Variant" />
<argument index="0" name="object" type="String" />
<description>
Creates a new JavaScript object using the [code]new[/code] constructor. The [code]object[/code] must a valid property of the JavaScript [code]window[/code]. See [JavaScriptObject] for usage.
</description>
</method>
<method name="download_buffer">
<return type="void">
</return>
<argument index="0" name="buffer" type="PoolByteArray">
</argument>
<argument index="1" name="name" type="String">
</argument>
<argument index="2" name="mime" type="String" default="&quot;application/octet-stream&quot;">
</argument>
<return type="void" />
<argument index="0" name="buffer" type="PoolByteArray" />
<argument index="1" name="name" type="String" />
<argument index="2" name="mime" type="String" default="&quot;application/octet-stream&quot;" />
<description>
Prompts the user to download a file containing the specified [code]buffer[/code]. The file will have the given [code]name[/code] and [code]mime[/code] type.
[b]Note:[/b] The browser may override the [url=https://en.wikipedia.org/wiki/Media_type]MIME type[/url] provided based on the file [code]name[/code]'s extension.
@@ -48,22 +39,17 @@
</description>
</method>
<method name="eval">
<return type="Variant">
</return>
<argument index="0" name="code" type="String">
</argument>
<argument index="1" name="use_global_execution_context" type="bool" default="false">
</argument>
<return type="Variant" />
<argument index="0" name="code" type="String" />
<argument index="1" name="use_global_execution_context" type="bool" default="false" />
<description>
Execute the string [code]code[/code] as JavaScript code within the browser window. This is a call to the actual global JavaScript function [code]eval()[/code].
If [code]use_global_execution_context[/code] is [code]true[/code], the code will be evaluated in the global execution context. Otherwise, it is evaluated in the execution context of a function within the engine's runtime environment.
</description>
</method>
<method name="get_interface">
<return type="JavaScriptObject">
</return>
<argument index="0" name="interface" type="String">
</argument>
<return type="JavaScriptObject" />
<argument index="0" name="interface" type="String" />
<description>
Returns an interface to a JavaScript object that can be used by scripts. The [code]interface[/code] must be a valid property of the JavaScript [code]window[/code]. The callback must accept a single [Array] argument, which will contain the JavaScript [code]arguments[/code]. See [JavaScriptObject] for usage.
</description>