Age | Commit message (Collapse) | Author |
|
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.
|
|
No longer hacked into `get_status` and renamed to `poll`.
The old `poll` (for *nix `poll`, win `select`) is now called `wait`.
|
|
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.
|
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
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.
|
|
- 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
|
|
|
|
The class name does not need to be specified when it is the current class.
|
|
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
|
|
|
|
neikeq/road-to-lang-agnostic-docs-is-going-to-be-tough
EditorHelp: Improve enum ref resolving and add constant ref support
|
|
|
|
Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
|
|
|
|
Thanks @PJB3005
|
|
|
|
This way they no longer appear in the documentation, and the related
setters and getters do.
|
|
Found via `codespell -q 3 -I ../godot-word-whitelist.txt --skip="./thirdparty,*.po"`
|
|
It has no practical use case and just generates noise for each alpha, beta, etc.
|
|
|
|
|
|
Pass enabled arg
Rename set_nodelay to set_no_delay
Add description to the method
Change description
|
|
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).
|
|
|
|
|
|
|
|
It is now "3.0-alpha" instead of "3.0.alpha.custom_build{,.mono}",
limits unnecessary diffs.
|
|
Also fix hyperlink references to same class as per the guidelines.
[ci skip]
|
|
possible to save module files in module directories and the build system will
recognize them.
|