diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2019-05-24 12:21:12 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-05-24 12:21:12 +0200 |
| commit | c8957295a6f86a53810ca7cbd57d8999a4c94f1f (patch) | |
| tree | ffa48bedd4ea1047dde4f11a09888489e2923a1e /doc/classes/StreamPeer.xml | |
| parent | 71d46fffcf39719fe2bfe9e64e78a08774546cb7 (diff) | |
| parent | 426bcc9941e98696c872b0f6421d2ef28b987e60 (diff) | |
Merge pull request #29146 from seandheffernan/returnFix2
Change "Return" to "Returns" where necessary in XML documentation
Diffstat (limited to 'doc/classes/StreamPeer.xml')
| -rw-r--r-- | doc/classes/StreamPeer.xml | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/doc/classes/StreamPeer.xml b/doc/classes/StreamPeer.xml index af8e43944c..d278312fc3 100644 --- a/doc/classes/StreamPeer.xml +++ b/doc/classes/StreamPeer.xml @@ -41,7 +41,7 @@ <return type="int"> </return> <description> - Return the amount of bytes this [StreamPeer] has available. + Returns the amount of bytes this [StreamPeer] has available. </description> </method> <method name="get_data"> @@ -50,7 +50,7 @@ <argument index="0" name="bytes" type="int"> </argument> <description> - Return 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 "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. </description> </method> <method name="get_double"> @@ -73,7 +73,7 @@ <argument index="0" name="bytes" type="int"> </argument> <description> - Return 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 Error code, and a data array. </description> </method> <method name="get_string"> |