From f7f6115f7627df24a08a9a0882b2f573cc838eb1 Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Sat, 22 Jun 2019 01:04:47 +0200 Subject: Proofread and improve the whole class reference - 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 --- doc/classes/StreamPeer.xml | 64 +++++++++++++++++++++++----------------------- 1 file changed, 32 insertions(+), 32 deletions(-) (limited to 'doc/classes/StreamPeer.xml') diff --git a/doc/classes/StreamPeer.xml b/doc/classes/StreamPeer.xml index d278312fc3..11b4c116c4 100644 --- a/doc/classes/StreamPeer.xml +++ b/doc/classes/StreamPeer.xml @@ -4,7 +4,7 @@ Abstraction and base class for stream-based protocols. - StreamPeer is an abstraction and base class for stream-based protocols (such as TCP or Unix Sockets). It provides an API for sending and receiving data through streams as raw data or strings. + StreamPeer is an abstraction and base class for stream-based protocols (such as TCP or UNIX sockets). It provides an API for sending and receiving data through streams as raw data or strings. @@ -13,28 +13,28 @@ - Get a signed 16 bit value from the stream. + Gets a signed 16-bit value from the stream. - Get a signed 32 bit value from the stream. + Gets a signed 32-bit value from the stream. - Get a signed 64 bit value from the stream. + Gets a signed 64-bit value from the stream. - Get a signed byte from the stream. + Gets a signed byte from the stream. @@ -50,21 +50,21 @@ - Returns a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an Error code and a data array. + Returns a chunk data with the received bytes. The amount of bytes to be received can be requested in the [code]bytes[/code] argument. If not enough bytes are available, the function will block until the desired amount is received. This function returns two values, an [enum @GlobalScope.Error] code and a data array. - Get a double-precision float from the stream. + Gets a double-precision float from the stream. - Get a single-precision float from the stream. + Gets a single-precision float from the stream. @@ -73,7 +73,7 @@ - Returns a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an Error code, and a data array. + Returns a chunk data with the received bytes. The amount of bytes to be received can be requested in the "bytes" argument. If not enough bytes are available, the function will return how many were actually received. This function returns two values, an [enum @GlobalScope.Error] code, and a data array. @@ -82,35 +82,35 @@ - Get a string with byte-length [code]bytes[/code] from the stream. If [code]bytes[/code] is negative (default) the length will be read from the stream using the reverse process of [method put_string]. + Gets a string with byte-length [code]bytes[/code] from the stream. If [code]bytes[/code] is negative (default) the length will be read from the stream using the reverse process of [method put_string]. - Get an unsigned 16 bit value from the stream. + Gets an unsigned 16-bit value from the stream. - Get an unsigned 32 bit value from the stream. + Gets an unsigned 32-bit value from the stream. - Get an unsigned 64 bit value from the stream. + Gets an unsigned 64-bit value from the stream. - Get an unsigned byte from the stream. + Gets an unsigned byte from the stream. @@ -119,7 +119,7 @@ - Get a utf8 string with byte-length [code]bytes[/code] from the stream (this decodes the string sent as utf8). If [code]bytes[/code] is negative (default) the length will be read from the stream using the reverse process of [method put_utf8_string]. + Gets an UTF-8 string with byte-length [code]bytes[/code] from the stream (this decodes the string sent as UTF-8). If [code]bytes[/code] is negative (default) the length will be read from the stream using the reverse process of [method put_utf8_string]. @@ -128,8 +128,8 @@ - Get a Variant from the stream. When [code]allow_objects[/code] is [code]true[/code] decoding objects is allowed. - [b]WARNING:[/b] Deserialized object can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats (remote code execution). + Gets a Variant from the stream. If [code]allow_objects[/code] is [code]true[/code], decoding objects is allowed. + [b]Warning:[/b] Deserialized objects can contain code which gets executed. Do not use this option if the serialized object comes from untrusted sources to avoid potential security threats such as remote code execution. @@ -138,7 +138,7 @@ - Put a signed 16 bit value into the stream. + Puts a signed 16-bit value into the stream. @@ -147,7 +147,7 @@ - Put a signed 32 bit value into the stream. + Puts a signed 32-bit value into the stream. @@ -156,7 +156,7 @@ - Put a signed 64 bit value into the stream. + Puts a signed 64-bit value into the stream. @@ -165,7 +165,7 @@ - Put a signed byte into the stream. + Puts a signed byte into the stream. @@ -174,7 +174,7 @@ - Send a chunk of data through the connection, blocking if necessary until the data is done sending. This function returns an Error code. + Sends a chunk of data through the connection, blocking if necessary until the data is done sending. This function returns an [enum @GlobalScope.Error] code. @@ -183,7 +183,7 @@ - Put a double-precision float into the stream. + Puts a double-precision float into the stream. @@ -192,7 +192,7 @@ - Put a single-precision float into the stream. + Puts a single-precision float into the stream. @@ -201,7 +201,7 @@ - Send a chunk of data through the connection, if all the data could not be sent at once, only part of it will. This function returns two values, an Error code and an integer, describing how much data was actually sent. + Sends a chunk of data through the connection. If all the data could not be sent at once, only part of it will. This function returns two values, an [enum @GlobalScope.Error] code and an integer, describing how much data was actually sent. @@ -210,7 +210,7 @@ - Put a zero-terminated ascii string into the stream prepended by a 32 bits unsigned integer representing its size. + Puts a zero-terminated ASCII string into the stream prepended by a 32-bit unsigned integer representing its size. @@ -219,7 +219,7 @@ - Put an unsigned 16 bit value into the stream. + Puts an unsigned 16-bit value into the stream. @@ -228,7 +228,7 @@ - Put an unsigned 32 bit value into the stream. + Puts an unsigned 32-bit value into the stream. @@ -237,7 +237,7 @@ - Put an unsigned 64 bit value into the stream. + Puts an unsigned 64-bit value into the stream. @@ -246,7 +246,7 @@ - Put an unsigned byte into the stream. + Puts an unsigned byte into the stream. @@ -255,7 +255,7 @@ - Put a zero-terminated utf8 string into the stream prepended by a 32 bits unsigned integer representing its size. + Puts a zero-terminated UTF-8 string into the stream prepended by a 32 bits unsigned integer representing its size. @@ -266,7 +266,7 @@ - Put a Variant into the stream. When [code]full_objects[/code] is [code]true[/code] encoding objects is allowed (and can potentially include code). + Puts a Variant into the stream. If [code]full_objects[/code] is [code]true[/code] encoding objects is allowed (and can potentially include code). -- cgit v1.2.3