diff options
| author | Yuri Sizov <11782833+YuriSizov@users.noreply.github.com> | 2022-08-12 15:29:58 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-08-12 15:29:58 +0300 |
| commit | 65a1d86c4f4b893c6e72c5434c22a5ab7dcbe68b (patch) | |
| tree | c3616eb558ec9af0434281f8054dd2b54206201f /doc/classes/StreamPeerTCP.xml | |
| parent | 67d40155206e7c15575ec9bd5b609075784ed746 (diff) | |
| parent | 1f72f48361e8a67a9473c99a27565fa6133c4b50 (diff) | |
Merge pull request #64196 from asmaloney/doc-params-3
[doc] Use "param" instead of "code" to refer to parameters #3
Diffstat (limited to 'doc/classes/StreamPeerTCP.xml')
| -rw-r--r-- | doc/classes/StreamPeerTCP.xml | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/classes/StreamPeerTCP.xml b/doc/classes/StreamPeerTCP.xml index 58f3a0e8db..c08fb82797 100644 --- a/doc/classes/StreamPeerTCP.xml +++ b/doc/classes/StreamPeerTCP.xml @@ -16,7 +16,7 @@ <param index="1" name="host" type="String" default=""*"" /> <description> Opens the TCP socket, and binds it to the specified local address. - This method is generally not needed, and only used to force the subsequent call to [method connect_to_host] to use the specified [code]host[/code] and [code]port[/code] as source address. This can be desired in some NAT punchthrough techniques, or when forcing the source network interface. + This method is generally not needed, and only used to force the subsequent call to [method connect_to_host] to use the specified [param host] and [param port] as source address. This can be desired in some NAT punchthrough techniques, or when forcing the source network interface. </description> </method> <method name="connect_to_host"> @@ -67,7 +67,7 @@ <return type="void" /> <param index="0" name="enabled" type="bool" /> <description> - If [code]enabled[/code] is [code]true[/code], packets will be sent immediately. If [code]enabled[/code] is [code]false[/code] (the default), packet transfers will be delayed and combined using [url=https://en.wikipedia.org/wiki/Nagle%27s_algorithm]Nagle's algorithm[/url]. + If [param enabled] is [code]true[/code], packets will be sent immediately. If [param enabled] is [code]false[/code] (the default), packet transfers will be delayed and combined using [url=https://en.wikipedia.org/wiki/Nagle%27s_algorithm]Nagle's algorithm[/url]. [b]Note:[/b] It's recommended to leave this disabled for applications that send large packets or need to transfer a lot of data, as enabling this can decrease the total available bandwidth. </description> </method> |