Changed description to be less confusing
Changed
"2D area for detection and physics and audio influence."
To
"2D area for detection, physics, and audio influence."
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.
Fix some typoed names from the doc
Add _index to "index" parameters of *_shape_* signals, this is both in doc and in the template. This makes the code, signature and doc easier to understand
Add method to get Node from the _index params of those signals. This was not as easy to find as one would expect. Putting this information where it is needed will help.
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.
This pull request fixes an assortment of typos and improves conciseness in `Animation`, `Area2D`, `Array`, `ArrayMesh`, `Control`, `Directory`, `EditorPlugin`, `Engine`, and `OS`.
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
Those signals receive either a PhysicsBody2D or a TileMap object,
and what the emitting method checks internally is only that the
object is a Node. In theory any Node could go through these signals
if they talk directly to the PhysicsServer2D.
Also updated docs.
Fixes#27076.
Might need further (compat breaking) improvement as this API is a
bit confusing, cf. #24739.
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
Rémi Verschelde
Matthew
Jay Mehta
Aaron Franke
Yuri Sizov
VolTer
Ricardo Buring
Andy Maloney
Rémi Verschelde
Hugo Locurcio
Charlie Burnham
PouleyKetchoupp
skyace65
Maxime Lapointe
Nicholas Huelin
Michael Alexsander Silva Dias
Jonathan Gollnick
Marcel Admiraal
Lightning_A
Tomasz Chabora
clayjohn
Lakshay Angrish
Derwent Ready (drentsoft)
Sean Heffernan