summaryrefslogtreecommitdiff
path: root/doc/classes/StreamPeer.xml
AgeCommit message (Collapse)Author
2023-01-31Fix C# examples in documentationRaul Santos
- Fix documentation after C# renames. - Add missing `partial` in C# class declarations. - Change `delta` parameter type to `double` in C#. - Ensure parameters match base declaration. - Use `$` string interpolation in C#. - Fix invalid or outdated C# code. - Changed some examples to follow our style guide more closely.
2022-11-02Style: Misc docs and comment style and language fixesRémi Verschelde
- Removed empty paragraphs in XML. - Consistently use bold style for "Example:", on a new line. - Fix usage of `[code]` when hyperlinks could be used (`[member]`, `[constant]`). - Fix invalid usage of backticks for inline code in BBCode. - Fix some American/British English spelling inconsistencies. - Other minor fixes spotted along the way, including typo fixes with codespell. - Don't specify `@GlobalScope` for `enum` and `constant`.
2022-08-17[doc] Fix grammar in class docs: amount vs. numberAndy Maloney
Number is used for things that can be counted (discrete items - think "integer" in this context). Also fixes a couple of awkward phrases.
2022-08-09[doc] Use "param" instead of "code" to refer to parameters #3Andy Maloney
2022-08-08Rename the argument tag to param in XML documentationYuri Sizov
2022-02-15Add an XML schema for documentationHugo Locurcio
This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2022-01-06Fix multiple missing UTF-8 decoding.bruvzg
2021-10-05doc: Fix style inconsistencies for `[b]Note:[/b]` paragraphsRémi Verschelde
And fix up formatting not supported by makerst.
2021-09-25Document Android permission requirements for network access where neededHugo Locurcio
2021-09-20Don't generate empty doc sections and reduce code duplicationAaron Franke
2021-07-30doc: Use self-closing tags for `return` and `argument`Rémi Verschelde
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.
2021-06-11Rename Reference to RefCountedPedro J. Estébanez
2021-05-20[Doc] Remove reference to UNIX sockets in StreamPeer.Fabio Alessandrelli
That class can be used as a base to implement them, but there is no actual implementation for it in Godot.
2021-03-05Docs: Port Code Examples to C# (R, S, T, U)HaSa1002
* RenderingServer * RichTextEffect * SceneTree * SceneTreeTimer * ScriptCreateDialog * SpinBox * Sprite2D * StreamPeer * String * SurfaceTool * TextEdit * TileMap * Tree * Tween * UDPServer * UndoRedo Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
2020-02-18doc: Sync classref with current sourceRémi Verschelde
Handle removal of Pool*Array types and other recent changes.
2020-01-31Update docs to version 4.0clayjohn
2020-01-26doc: Drop unused 'category' property from headerRémi Verschelde
We already removed it from the online docs with #35132. Currently it can only be "Built-In Types" (Variant types) or "Core" (everything else), which is of limited use. We might also want to consider dropping it from `ClassDB` altogether in Godot 4.0.
2019-10-04doc: Add note about sending strings without size in StreamPeerRémi Verschelde
Follow-up to #29153.
2019-06-30doc: Add default values to all propertiesRémi Verschelde
Thanks to @bojidar-bg's impressive work in #29380.
2019-06-27Proofread and improve the whole class referenceHugo Locurcio
- 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
2019-05-23Change "Return" to "Returns" where necessary in XML documentationSean Heffernan
In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867
2019-04-19doc: Drop unused <demos> tagRémi Verschelde
2019-04-05Merge pull request #27465 from ↵Rémi Verschelde
neikeq/road-to-lang-agnostic-docs-is-going-to-be-tough EditorHelp: Improve enum ref resolving and add constant ref support
2019-04-01Merge pull request #27485 from Faless/io/encode_decode_safety_prRémi Verschelde
Safer encode/decode variant.
2019-04-01Add object encoding param to serialization methodsFabio Alessandrelli
Network peers get_var/put_var File get_var/store_var GDScript/Mono/VisualScript bytes2var/var2bytes Add MultiplayerAPI.allow_object_decoding member which deprecates PacketPeer.allow_object_decoding. Break ABI compatibaility (API compatibility for GDNative).
2019-04-01doc: Bump version to 3.2Rémi Verschelde
2019-03-29ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass]Ignacio Etcheverry
Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2018-09-22StreamPeer get[_utf8]_string with negative length.Fabio Alessandrelli
If the "bytes" parameter of get_string and get_utf8_string is negative, the length will be read from the stream instead. The bytes parameter has now a default (-1), allowing to use them directly as reverses of put_string and put_utf8_string . put_string was not implemented, so I implemented it to allow sending ASCII strings (which are much smaller than UTF8 ones).
2018-02-27doc: Remove status from hardcoded version stringRémi Verschelde
It has no practical use case and just generates noise for each alpha, beta, etc.
2018-02-19doc: Update version string in headerRémi Verschelde
2018-01-25doc: Sync with current sourceRémi Verschelde
Also enhance RigidBody docs as per https://github.com/godotengine/godot-docs/pull/1018 and fix the version tag in all files (not really stable yet, but it makes no sense to hardcode rc3 at this stage).
2018-01-17doc: Replace some more "val" with "value" + syncRémi Verschelde
2018-01-13doc: Update version string in XMLRémi Verschelde
2018-01-12Update docsBojidar Marinov
[ci skip]
2017-12-31Minor docs fixPoommetee Ketson
2017-11-24doc: Update header version for 3.0-betaRémi Verschelde
2017-11-15doc: Remove revision.module_config from version stringRémi Verschelde
It is now "3.0-alpha" instead of "3.0.alpha.custom_build{,.mono}", limits unnecessary diffs.
2017-10-22classref: Sync with current sourceRémi Verschelde
Also fix hyperlink references to same class as per the guidelines. [ci skip]
2017-09-12Changed the doc class generation to individual files per class. It is also ↵Juan Linietsky
possible to save module files in module directories and the build system will recognize them.
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-16 01:31:25 +0000