b68dd2e189
Add an XML schema for documentation
...
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.
2022-02-15 00:03:31 +01:00
a1ab50a9f0
Document that transparent StyleBoxes/textures should be used for UI focus
2021-12-15 18:22:39 +01:00
b3992f7e6e
Make overridden properties link to parent definition
...
Co-authored-by: Josh DeGraw <joshmdegraw@gmail.com>
2021-12-03 17:47:22 +03:00
397e56964d
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 21:02:20 +03:00
12838bd99d
Add focus font color to Button and derivatives
2021-10-26 17:42:40 +03:00
07725b611b
Add warnings to methods that give access to internal nodes
2021-10-10 22:57:58 +03:00
67db227f86
Add usability notes to ColorPicker and ColorPickerButton descriptions
...
Co-authored-by: follower <follower@rancidbacon.com>
2021-09-25 02:21:31 +03:00
d54f2ad7ca
Don't generate empty doc sections and reduce code duplication
2021-09-20 20:59:33 -05:00
bf2839ea3e
Add theme item descriptions to the online documentation
2021-08-04 22:27:10 +03:00
7adf4cc9b5
doc: Use self-closing tags for `return` and `argument`
...
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-30 15:29:52 +02:00
0ff4095b36
Better format arguments in variant parser
2021-06-18 00:06:40 -03:00
d78336c65e
[CTL] Add missing font outline drawing routines and theme constants.
2021-02-14 14:11:44 +02:00
8eb39f4e8b
Change themes *_color_* to *_*_color
...
Changed:
font_color_accel -> font_accelerator_color
font_color_bg -> font_unselected_color
font_color_disabled -> font_disabled_color
font_color_fg -> font_selected_color
font_color_hover -> font_hover_color
font_color_hover_pressed -> font_hover_pressed_color
font_color_pressed -> font_pressed_color
font_color_readonly -> font_readonly_color
font_color_selected -> font_selected_color
font_color_shadow -> font_shadow_color
font_color_uneditable -> font_uneditable_color
icon_color_disabled -> icon_disabled_color
icon_color_hover -> icon_hover_color
icon_color_hover_pressed -> icon_hover_pressed_color
icon_color_normal -> icon_normal_color
icon_color_pressed -> icon_pressed_color
Also includes:
font_outline_modulate -> font_outline_color
tab_fg -> tab_selected
tab_bg -> tab_unselected
2021-01-24 06:28:49 +00:00
7e2c0ffd1a
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-11-26 14:25:52 +02:00
439be614f4
Link to demos from within the class reference
2020-10-01 23:57:21 -04:00
038baede5a
Reference the BaseButton class explicitly in button class documentations
...
Users are sometimes confused as to the `pressed` property not being
visible in the Button class documentation. This is because `pressed`
is defined in BaseButton.
2020-09-23 23:34:28 +02:00
0e3d625737
doc: Sync classref with current source
...
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.
2020-02-12 12:37:13 +01:00
db42d5ddff
Completes doc for button classes
2020-02-05 08:44:16 +08:00
57e27683ba
Update docs to version 4.0
2020-01-31 17:15:41 -08:00
2d20fc39aa
doc: Drop unused 'category' property from header
...
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.
2020-01-26 16:02:39 +01:00
c09b9c488f
Complete documentation of some more classes
2020-01-14 13:19:39 +01:00
a7ac8ec876
doc: Fix parsing of self-closing XML tags
...
Follow-up to #31925 , `<member />` tags just before `</members>` would cause
a parsing issue, and we'd never notice that we're no longer parsing members.
Also added space before closing `/>`.
2019-09-24 13:34:05 +02:00
2f52d73c21
Merge pull request #31925 from bojidar-bg/31855-overriden-properties-docs
...
Add overriden properties to the documentation
2019-09-24 11:53:43 +02:00
4f294b958f
doc: Sync classref with current source
...
Fix a few missing bindings or unspecified argument names and default values.
2019-09-24 11:52:06 +02:00
b397bcf4a1
Run doctool after overridden properties changes
2019-09-04 15:26:08 +03:00
b9aa13e591
doc: Remove hardcoded default values from descriptions
...
They are now generated automatically by doctool.
2019-06-30 13:58:07 +02:00
c6cea6e9b3
doc: Add default values to all properties
...
Thanks to @bojidar-bg's impressive work in #29380 .
2019-06-30 13:58:07 +02:00
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
6cdcde7114
doc: Add missing commas after "If true/false"
2018-12-20 13:47:12 +01:00
08bde5b2de
Misc. typos
...
Found via `codespell -q 3 -I ../godot-word-whitelist.txt --skip="./thirdparty,*.po"`
2018-09-12 21:39:17 -04:00
23b7edb214
[DOCS] Updates to assorted class descriptions.
2018-08-17 14:55:19 -07:00
391e46830f
doc: Sync classref with current source
...
Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
4c5dd51eb9
Sync classref with current source
...
Also fix binding of Basis.slerp
2018-05-28 14:53:15 +02:00
3d9deda8b3
Sync classref with current source
2018-05-12 09:38:00 +02:00
d912e10c65
Added missing end points for brief descriptions in the docs.
2018-03-30 20:11:14 -03:00
3fa77b3172
doc: Remove status from hardcoded version string
...
It has no practical use case and just generates noise for each alpha, beta, etc.
2018-02-27 13:40:49 +01:00
3c7a39b40c
doc: Update version string in header
2018-02-19 10:46:33 +01:00
d516aab8fa
doc: Sync with current source
...
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-25 08:50:56 +01:00
e28cdc4654
doc: Update version string in XML
2018-01-13 11:43:42 +01:00
23080c7ed7
Made MenuButton and ColorPickerButton's "get_popup" methods return constant.
2017-12-25 14:03:53 -02:00
7d440d04aa
doc: Sync classref with current source
2017-12-07 08:23:08 +01:00
e334b0c4b2
Merge pull request #13491 from RaXaR/master
...
Added get_popup() method to ColorPickerButton...
2017-12-06 23:47:43 +01:00
e0ced07fff
[DOCS] ColorPickerButton member/method descs
2017-12-04 14:27:45 -06:00
d6d0df4ba6
Added get_popup() method to ColorPickerButton. This allows to check if the picker is open or not using Popup signals.
...
Ammend: Added docs for the method.
2017-12-01 23:18:01 +02:00
92f07fefcd
doc: Remove setters and getters now exposed via properties/members
2017-11-24 18:10:32 +01:00
bc75fae579
doc: Update header version for 3.0-beta
2017-11-24 09:16:52 +01:00
967bfb0c4a
doc: Remove revision.module_config from version string
...
It is now "3.0-alpha" instead of "3.0.alpha.custom_build{,.mono}",
limits unnecessary diffs.
2017-11-15 20:41:16 +01:00
b1f2c31a36
doc: Sync classref with current source
...
Ensure that s/fixed_process/physics_process/ is handled properly.
[ci skip]
2017-10-11 23:55:04 +02:00
a4005221f5
doc: Sync classref with current source
...
[ci skip]
2017-09-13 08:53:01 +02:00
Hugo Locurcio
Yuri Sizov
Aaron Franke
Rémi Verschelde
Michael Alexsander Silva Dias
bruvzg
Marcel Admiraal
Haoyu Qiu
clayjohn
Tomasz Chabora
Bojidar Marinov
luz.paz
Chris Bradfield
Will Nations
RaXaR