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

24
doc/classes/TCPServer.xml
View File

@@ -10,33 +10,27 @@
</tutorials>
<methods>
<method name="get_local_port" qualifiers="const">
<return type="int">
</return>
<return type="int" />
<description>
Returns the local port this server is listening to.
</description>
</method>
<method name="is_connection_available" qualifiers="const">
<return type="bool">
</return>
<return type="bool" />
<description>
Returns [code]true[/code] if a connection is available for taking.
</description>
</method>
<method name="is_listening" qualifiers="const">
<return type="bool">
</return>
<return type="bool" />
<description>
Returns [code]true[/code] if the server is currently listening for connections.
</description>
</method>
<method name="listen">
<return type="int" enum="Error">
</return>
<argument index="0" name="port" type="int">
</argument>
<argument index="1" name="bind_address" type="String" default="&quot;*&quot;">
</argument>
<return type="int" enum="Error" />
<argument index="0" name="port" type="int" />
<argument index="1" name="bind_address" type="String" default="&quot;*&quot;" />
<description>
Listen on the [code]port[/code] binding to [code]bind_address[/code].
If [code]bind_address[/code] is set as [code]"*"[/code] (default), the server will listen on all available addresses (both IPv4 and IPv6).
@@ -45,15 +39,13 @@
</description>
</method>
<method name="stop">
<return type="void">
</return>
<return type="void" />
<description>
Stops listening.
</description>
</method>
<method name="take_connection">
<return type="StreamPeerTCP">
</return>
<return type="StreamPeerTCP" />
<description>
If a connection is available, returns a StreamPeerTCP with the connection.
</description>