seedlingattempt/godot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 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

14
doc/classes/StreamPeerTCP.xml
View File

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="StreamPeerTCP" inherits="StreamPeer" category="Core" version="3.2">
<brief_description>
TCP Stream peer.
TCP stream peer.
</brief_description>
<description>
TCP Stream peer. This object can be used to connect to TCP servers, or also is returned by a TCP server.
TCP stream peer. This object can be used to connect to TCP servers, or also is returned by a TCP server.
</description>
<tutorials>
</tutorials>
@ -17,14 +17,14 @@
<argument index="1" name="port" type="int">
</argument>
<description>
Connect to the specified host:port pair. A hostname will be resolved if valid. Returns [constant OK] on success or [constant FAILED] on failure.
Connects to the specified [code]host:port[/code] pair. A hostname will be resolved if valid. Returns [constant OK] on success or [constant FAILED] on failure.
</description>
</method>
<method name="disconnect_from_host">
<return type="void">
</return>
<description>
Disconnect from host.
Disconnects from host.
</description>
</method>
<method name="get_connected_host" qualifiers="const">
@ -61,14 +61,14 @@
<argument index="0" name="enabled" type="bool">
</argument>
<description>
Disable Nagle algorithm to improve latency for small packets.
Note that for applications that send large packets, or need to transfer a lot of data, this can reduce total bandwidth.
Disables Nagle's algorithm to improve latency for small packets.
[b]Note:[/b] For applications that send large packets or need to transfer a lot of data, this can decrease the total available bandwidth.
</description>
</method>
</methods>
<constants>
<constant name="STATUS_NONE" value="0" enum="Status">
The initial status of the [StreamPeerTCP], also the status after a disconnect.
The initial status of the [StreamPeerTCP]. This is also the status after disconnecting.
</constant>
<constant name="STATUS_CONNECTING" value="1" enum="Status">
A status representing a [StreamPeerTCP] that is connecting to a host.