summaryrefslogtreecommitdiffstats
path: root/doc/classes/PacketPeer.xml
Commit message (Collapse)AuthorAgeFilesLines
* Validate `code` tags for class and member referencesYuri Sizov2023-10-031-1/+1
| | | | | | | | This commit also adds means to manually disable warnings in `code` tags where it's a false positive with the new `skip-lint` attribute. Warnings are now enabled on CI to prevent future errors.
* Doctool: Remove version attribute from XML headerRémi Verschelde2023-07-061-1/+1
| | | | | | We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb).
* Bump version to 4.2-devRémi Verschelde2023-07-051-1/+1
| | | | Keep on waitin'
* Bump version to 4.1-devRémi Verschelde2023-03-011-1/+1
| | | | Can't stop, won't stop, they said, huh?
* Document internal usage of encode/decode_variantRedMser2023-01-171-0/+2
|
* [doc] Use "param" instead of "code" to refer to parameters (4)Andy Maloney2022-08-111-2/+2
|
* Rename the argument tag to param in XML documentationYuri Sizov2022-08-081-4/+4
|
* Add an XML schema for documentationHugo Locurcio2022-02-151-1/+1
| | | | | | | | 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.
* Document Android permission requirements for network access where neededHugo Locurcio2021-09-251-0/+1
|
* Don't generate empty doc sections and reduce code duplicationAaron Franke2021-09-201-2/+0
|
* doc: Use self-closing tags for `return` and `argument`Rémi Verschelde2021-07-301-20/+10
| | | | | | | | 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.
* Rename Reference to RefCountedPedro J. Estébanez2021-06-111-1/+1
|
* doc: Sync classref with current sourceRémi Verschelde2020-02-181-2/+2
| | | | Handle removal of Pool*Array types and other recent changes.
* Remove deprecated PacketPeer allow_object_decodingRémi Verschelde2020-02-131-7/+2
| | | | | | | | It was added for 3.2 in #27485 to preserve backwards compatibility, but we can now remove it. It is still needed in MultiplayerAPI as it's the only way to control it for the internal put_var calls.
* Update docs to version 4.0clayjohn2020-01-311-1/+1
|
* doc: Drop unused 'category' property from headerRémi Verschelde2020-01-261-1/+1
| | | | | | | | | | 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.
* doc: Sync classref with current sourceRémi Verschelde2020-01-191-0/+4
|
* doc: Add default values to all propertiesRémi Verschelde2019-06-301-1/+1
| | | | Thanks to @bojidar-bg's impressive work in #29380.
* Proofread and improve the whole class referenceHugo Locurcio2019-06-271-9/+9
| | | | | | | | | | | | | - 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
* Change "Return" to "Returns" where necessary in XML documentationSean Heffernan2019-05-231-2/+2
| | | | | | | | 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
* doc: Drop unused <demos> tagRémi Verschelde2019-04-191-2/+0
|
* Merge pull request #27485 from Faless/io/encode_decode_safety_prRémi Verschelde2019-04-011-2/+10
|\ | | | | Safer encode/decode variant.
| * Add object encoding param to serialization methodsFabio Alessandrelli2019-04-011-2/+8
| | | | | | | | | | | | | | | | | | 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).
| * Multiplayer API now respects allow_object_decodingFabio Alessandrelli2019-04-011-0/+2
| | | | | | | | Add doc about allow_object_decoding in PacketPeer
* | doc: Bump version to 3.2Rémi Verschelde2019-04-011-1/+1
|/
* doc: Remove status from hardcoded version stringRémi Verschelde2018-02-271-1/+1
| | | | It has no practical use case and just generates noise for each alpha, beta, etc.
* doc: Update version string in headerRémi Verschelde2018-02-191-1/+1
|
* doc: Sync with current sourceRémi Verschelde2018-01-251-1/+1
| | | | | | 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).
* doc: Update version string in XMLRémi Verschelde2018-01-131-1/+1
|
* Update docsBojidar Marinov2018-01-121-14/+4
| | | | [ci skip]
* Bind TextEdit.deselect and update documentationRémi Verschelde2017-12-161-2/+2
|
* doc: Update header version for 3.0-betaRémi Verschelde2017-11-241-1/+1
|
* doc: Remove revision.module_config from version stringRémi Verschelde2017-11-151-1/+1
| | | | | It is now "3.0-alpha" instead of "3.0.alpha.custom_build{,.mono}", limits unnecessary diffs.
* Changed the doc class generation to individual files per class. It is also ↵Juan Linietsky2017-09-121-0/+77
possible to save module files in module directories and the build system will recognize them.