summaryrefslogtreecommitdiff
path: root/doc/classes/PacketPeerUDP.xml
AgeCommit message (Collapse)Author
2022-08-11[doc] Use "param" instead of "code" to refer to parameters (4)Andy Maloney
2022-08-08Rename the argument tag to param in XML documentationYuri Sizov
2022-03-27[Net] Drop is_connected_to_host for TCP and UDP.Fabio Alessandrelli
The UDP method is now called `is_socket_connected` to limit confusion with the actual host connection status which doesn't make sense in UDP. The TCP method is completly dropped, use get_status instead. The only one left is the WebSocketPeer one, which should be fine as is for now.
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.
2021-12-15Fix indentations in class reference XMLsHaoyu Qiu
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-07-13Fix casing of the "to" stop word in editor stringsHugo Locurcio
This also fixes a C# documentation example that had one of its strings incorrectly converted.
2021-04-12This renames PacketPeerUDP.listen to bind.Fabio Alessandrelli
2021-04-12Allow local port control on net_socket connectionsdam
2020-11-09Docs: Port Code Examples to C# (M, N, O, P, R)HaSa1002
Includes: * MarginContainer * NavigationPolygon * Node * NodePath * OS * PackedByteArray * PackedScene * PacketPeerUDP * PCKPacker * Performance * PhysicsShapeQueryParameters2D * PhysicsShapeQueryParameters3D * PrimitiveMesh * ProjectSettings Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
2020-10-15Document how to interrupt `PacketPeerUDP.wait()`Hugo Locurcio
This closes #36335.
2020-03-11Fix various typosluz.paz
Found via `codespell`
2020-02-17Add documentation for new DTLS features.Fabio Alessandrelli
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-12-14Add Android NetSocket implementation.Fabio Alessandrelli
Automatically acquire and release multicast lock when needed.
2019-12-14UDP sockets broadcast is now disabled by default.Fabio Alessandrelli
Add method `set_broadcast_enabled` to allow enabling broadcast via GDScript.
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-06-21Multicast support in NetSocket/PacketPeerUDPFabio Alessandrelli
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-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-05-14[docs] fix links in class docsKelly Thomas
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-13doc: Update version string in XMLRémi Verschelde
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-10-21makerst: Fix rst-ization of members and escaping of [Class]sRémi Verschelde
Fixes #11517.
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.