Hugo Locurcio
b087538119
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-03-16 23:01:02 +01:00
Haoyu Qiu
c9f9e06775
Fix documentation about TreeItem button ID
...
(cherry picked from commit bb766a8fb6
)
2022-02-17 09:59:28 +01:00
Haoyu Qiu
a3f6033513
Improve TreeItem button API
2022-02-08 23:56:19 +08:00
Rémi Verschelde
14c366ddd7
Bump version to 3.5-beta
2021-11-05 16:10:17 +01:00
Rémi Verschelde
f5836b40d4
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.
(cherry picked from commit 7adf4cc9b5
)
2021-08-03 10:20:19 +02:00
Rémi Verschelde
c3272997cd
doc: Update classref headers with 3.4 version
2021-04-26 13:15:29 +02:00
Rémi Verschelde
1aba997d75
doc: Sync classref with 3.3 version bump
2021-03-23 13:40:34 +01:00
James Westman
7ce1789597
docs: Add TreeItem method descriptions
...
(cherry picked from commit 2f5164d78c
)
2021-02-02 13:02:46 +01:00
TheDuriel
7e9b7b0462
Clarify TreeItem return values
...
(cherry picked from commit 0ff1ca4655
)
2020-07-31 13:08:40 +02:00
Rémi Verschelde
4daba9bfc5
doc: Sync classref with current source
2020-05-07 13:47:06 +02:00
Tomasz Chabora
6bb87d7d23
Mention how to remove TreeItem from a Tree
...
(cherry picked from commit f6aec99d27
)
2020-05-01 10:56:58 +02:00
Rémi Verschelde
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
Rémi Verschelde
4eff13d768
doc: Markup fixes for enums and constants
2019-12-06 23:09:20 +01:00
Rémi Verschelde
d655a7c097
doc: Sync classref with current source
2019-10-11 08:45:03 +02:00
dankan1890
b469ff17e2
Added missing bind_method to TreeItem::get_custom_color().
...
Fix #32595
2019-10-06 22:07:50 +02:00
Rémi Verschelde
ee611d149b
Merge pull request #22834 from lupoDharkael/recursive-item
...
Add call_recursive method to TreeItem
2019-10-04 15:32:14 +02:00
Rémi Verschelde
d0e45e78a4
doc: Sync classref with current source
...
And various fixes to bindings, hyperlinks and an uninitialized variable.
2019-09-27 22:16:42 +02:00
Nolan Darilek
5629a006d9
#14011 : Implement TreeItem.get_button_tooltip(column, idx)
.
...
When added to `TreeItem`, buttons are given tooltips. When returned via `get_button(...)`, however, the button is a `Texture` and the tooltip information isn't included.
For accessibility purposes, it is useful to have access to the tooltip text. As such, we can retrieve a button's tooltip to use as a button label.
2019-09-26 10:41:02 -05:00
lupoDharkael
306e64a9f5
Add call_recursive method to TreeItem
2019-09-04 12:42:08 +02:00
merumelu
eac0af5892
Tree: fix and expose icon modulation
2019-08-24 17:37:22 +02:00
Meriipu
e5f4a85a7e
documented set_button_disabled
2019-07-17 10:22:02 +02:00
Rémi Verschelde
9580c2b13e
TreeItem: Rename new button disable method to set_button_disabled
...
Follow-up to #30408 .
Also sync classref with current source.
2019-07-09 09:17:42 +02:00
Hugo Locurcio
f7f6115f76
Proofread and improve the whole class reference
...
- 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-27 22:30:19 +02:00
Rémi Verschelde
cfb9709c10
doc: Sync classref with current source
2019-06-01 12:34:29 +02:00
Rémi Verschelde
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
Rémi Verschelde
63d3a42f82
Merge pull request #27465 from neikeq/road-to-lang-agnostic-docs-is-going-to-be-tough
...
EditorHelp: Improve enum ref resolving and add constant ref support
2019-04-05 15:19:21 +02:00
Rémi Verschelde
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
Ignacio Etcheverry
d80bc5cbba
ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass]
...
Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-03-29 23:47:35 +01:00
Rémi Verschelde
6cdcde7114
doc: Add missing commas after "If true/false"
2018-12-20 13:47:12 +01:00
M. Huri
967831d9a0
[Docs] Fixed 'get_button_count's link and a typo related to 'button'.
2018-10-13 17:34:57 +07:00
Kelly Thomas
b150ceb62c
Update class documentation xml
2018-10-07 21:57:26 +08:00
florian
612193b77f
Add critical info to TreeItem.set_custom_draw documentation
...
Indicates that the method needs 2 arguments to be called
2018-10-02 19:42:58 +02:00
Max Hilbrunner
25b5242d9f
[DOCS] TreeItem: Small fix for remove_child()
2018-06-18 03:28:26 +02:00
Rémi Verschelde
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
Rémi Verschelde
3c7a39b40c
doc: Update version string in header
2018-02-19 10:46:33 +01:00
Rémi Verschelde
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
Rémi Verschelde
e28cdc4654
doc: Update version string in XML
2018-01-13 11:43:42 +01:00
Bojidar Marinov
ad79c70300
Update docs
...
[ci skip]
2018-01-12 00:58:22 +02:00
Rémi Verschelde
7dfba3cda9
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +01:00
Rémi Verschelde
bc75fae579
doc: Update header version for 3.0-beta
2017-11-24 09:16:52 +01:00
Rémi Verschelde
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
Rémi Verschelde
fc09e14366
classref: Sync with current source
...
Also fix hyperlink references to same class as per the guidelines.
[ci skip]
2017-10-22 12:56:17 +02:00
Rémi Verschelde
b302084395
makerst: Fix rst-ization of members and escaping of [Class]s
...
Fixes #11517 .
2017-10-21 12:33:52 +02:00
Rémi Verschelde
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
mhilbrunner
b776330cb7
[DOCS] Document Tree
2017-10-09 22:44:27 +02:00
Rémi Verschelde
62cb43bb8d
doc: Sync classref with current source
...
[ci skip]
2017-09-16 01:46:29 +02:00
Rémi Verschelde
cc30e2a9a5
doc: Sync classref with current source
...
[ci skip]
2017-09-13 20:56:23 +02:00
Juan Linietsky
4f929a0fdf
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will
...
recognize them.
2017-09-12 17:45:41 -03:00