Age | Commit message (Collapse) | Author |
|
CanvasItem, Theme and modified controls documentation.
|
|
Rename the `type` parameter to `node_type` in Theme and Control
|
|
The return type for `_make_custom_tooltip` is clarified as Control, and users
should make sure to return a visible node for proper size calculations.
Moreover in the current master branch, a PopupPanel will be added as parent
to the provided tooltip to make it a sub-window.
Clarifies documentation for `Control._make_custom_tooltip`, and shows how to
use the (until now undocumented) "TooltipPanel" and "TooltipLabel" theme types
to style tooltips.
Fixes #39677.
|
|
This makes it clearer that it expects a node type as a string
(such as "Label") instead of a type like "TYPE_ARRAY".
This is backwards-compatible since only the name of the parameter
is changed, not its order.
|
|
|
|
|
|
Translates Code Examples in classes beginning with `C`.
Includes:
* Callable
* CanvasItem
* CharFXTransform
* Color
* ColorRect
* ConfigFile
* ConfirmationDialog
* Control
* Crypto
|
|
This makes them display in a nicer way in the editor help.
(The title will display instead of the full URL.)
|
|
Overriding theme items is a common point of confusion.
Hopefully, these code samples should clear things up.
|
|
This is a common topic of confusion. Clarifying its intended scope
should make things easier to understand.
|
|
|
|
CanvasItem based nodes.
Resolves #37683
|
|
|
|
|
|
Lots of internal API changes and some docstrings were lost in the conversion.
I manually salvaged many of them but for all the rendering-related ones, an
additional pass is needed.
Added missing enum bindings in BaseMaterial3D and VisualServer.
|
|
|
|
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.
|
|
|
|
|
|
|
|
Found using `codespell -q 3 -S ./thirdparty,*.po -L ang,ba,cas,dof,doubleclick,fave,hist,leapyear,lod,nd,numer,ois,paket,seeked,sinc,switchs,te,uint -D ~/Projects/codespell/codespell_lib/data/dictionary.txt `
|
|
|
|
Fix wrong hyperlinks in Control and Tree.
|
|
|
|
|
|
|
|
Setters and getters have been hidden from the documentation when the matching
properties have been exposed, but some of them are parametric and require the
name or index of a given parameter to be used. So they need to be properly
documented with the type and name of the arguments they take.
For example, CPUParticles' `set_param(Parameter param, float value)`.
|
|
Applying #30187.
|
|
They are now generated automatically by doctool.
|
|
Thanks to @bojidar-bg's impressive work in #29380.
|
|
- 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
|
|
|
|
This is not necessary and means that some setters and getters
can end up wrong if they are changed in the bindings but DocData
does not update them when running --doctool.
Fixes #29425.
Co-authored-by: Bojidar Marinov <bojidar.marinov.bg@gmail.com>
|
|
I hope this is the right place to edit now.
|
|
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
|
|
|
|
Consistently wrap booleans in [code]
|
|
|
|
|
|
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.
|
|
Also enhance Control/Label documentation about tooltips and mouse filter,
as it took me a while to understand why Labels didn't show tooltips.
Closes #26082.
|
|
Using codespell 1.14.0.
Method:
```
$ cat > ../godot-word-whitelist.txt << EOF
ang
doubleclick
lod
nd
numer
que
te
unselect
EOF
$ codespell -w -q 3 -I ../godot-word-whitelist.txt --skip="./thirdparty,*.po"
$ git diff // undo unwanted changes
```
|
|
The mouse_filter documentation was biased towards button click events, so add more mention of its impact on mouse_entered and mouse_exited signals as well.
|
|
|
|
Thanks @PJB3005
|
|
Improve documentation of Control.
|
|
|
|
|