godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
33,543 Commits 15 Branches 59 Tags 2.2 GiB
Commit Graph

62 Commits

Author SHA1 Message Date
kleonc b0bcbcc094 Tree::get_edited Fix in docs example code 2022-05-05 15:07:40 +02:00
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 a3f6033513 Improve TreeItem button API 2022-02-08 23:56:19 +08:00
Rémi Verschelde 2eb12f1d71
doc: Clarify expected type of `Object *` parameters in Tree methods 
They're meant to be `TreeItem *` but this can't be bound in Variant.

Fixes #20538.

(cherry picked from commit 81f2ce4e46)
 2022-01-25 18:24:02 +01:00
Rémi Verschelde eac0d90c39
Merge pull request #55560 from pycbouh/docs-overridden-cross-linked-3.x 
[3.x] Make overridden properties link to parent definition
 2021-12-10 12:42:09 +01:00
Rémi Verschelde 643a9a3420
Merge pull request #55526 from pycbouh/docs-sort-group-newline-theme-and-enums-3.x 2021-12-07 12:14:48 +01:00
kobewi 9776241ce6
Bind column_titles_visible as property 
(cherry picked from commit 7f6ab0006d)
 2021-12-06 16:52:00 +01:00
Yuri Sizov 1cf6d21f69 Make overridden properties link to parent definition 
Co-authored-by: Josh DeGraw <joshmdegraw@gmail.com>
 2021-12-03 17:48:49 +03:00
Yuri Sizov ebd8101546 Sort and group theme properties in docs, improve formatting for theme and enums 2021-12-01 22:48:17 +03:00
Rémi Verschelde 14c366ddd7
Bump version to 3.5-beta 2021-11-05 16:10:17 +01:00
Yuri Sizov fcbe5a3fde Add theme item descriptions to the online documentation 2021-08-06 18:20:51 +03: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
Nick Huelin ad1aea9a46
Add multiple descriptions to several classes 
This pull request adds several descriptions to multiple different classes.

This improves the completeness of the documentation and enhances usability by doing so.

(cherry picked from commit 27e9df7778)
 2021-07-06 15:30:13 +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
Jummit 0a9190134d expose edit_selected in Tree 
(cherry picked from commit 13fb24cb6f)
 2021-02-25 15:14:32 +01:00
Rémi Verschelde 7c3602dc8c
doc: Sync classref with current source 2021-02-16 14:47:29 +01:00
Tomasz Chabora 17af75953f
Correct the doc about Tree.get_edited 
(cherry picked from commit b8145c182b)
 2020-11-17 12:07:02 +01: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
Tomasz Chabora 3739f03d98 Add LOTS of missing docs 
(cherry picked from commit e103f21a40)
 2020-03-13 17:26:30 +01:00
Haoyu Qiu 7cfcf1824b Completes doc for ItemList and Tree 
(cherry picked from commit 7a41c44be2)
 2020-02-12 15:05:02 +01: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
Haoyu Qiu 8a4104acb8 Improves Tree documentation 2020-01-04 20:25:40 +08:00
Rémi Verschelde 4eff13d768 doc: Markup fixes for enums and constants 2019-12-06 23:09:20 +01:00
Rémi Verschelde 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
Rémi Verschelde 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
Hugo Locurcio 40a5de97e6
Remove an unused icon and constant in Tree 2019-09-20 17:50:13 +02:00
Bojidar Marinov b397bcf4a1
Run doctool after overridden properties changes 2019-09-04 15:26:08 +03:00
Rémi Verschelde 1349e0e585 doc: Sync classref with current source 
Fix wrong hyperlinks in Control and Tree.
 2019-08-22 14:49:30 +02:00
Twarit Waikar d366855abd
Add Tree iteration instructions thorugh TreeItem 2019-08-09 01:09:50 +05:30
Meriipu 94c5e6a97e Document Tree column behaviour of min_width in conjunction w expand 2019-07-17 13:52:57 +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
Rémi Verschelde 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
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 bc82781f7d doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinks 2019-06-27 13:49:36 +02:00
Rémi Verschelde 3a365c1fc0 doc: Sync classref with current source 2019-05-28 18:08:13 +02:00
Rémi Verschelde 6af69f851a doc: Drop unused <demos> tag 2019-04-19 11:03:46 +02:00
Rémi Verschelde 39c868171e doc: Bump version to 3.2 2019-04-01 12:33:56 +02:00
Rémi Verschelde 6cdcde7114 doc: Add missing commas after "If true/false" 2018-12-20 13:47:12 +01:00
Michael Alexsander Silva Dias 2049efc1e3 General fixes for the new unified help search 2018-11-22 19:41:10 -02:00
Rémi Verschelde daa9092ed3 doc: Sync classref with current source 2018-11-20 09:34:45 +01:00
Kelly Thomas b1ab7b4acf [Docs] Fix some broken links 2018-10-06 04:20:16 +08:00
LikeLakers2 eaac1e3b81 [Docs] Remove double-spaces from descriptions, as well a couple other small fixes 2018-09-23 16:13:30 -04:00
Kelly Thomas 3dc0d17c6f Change return value of Tree.create_item() from Object to TreeItem 2018-09-03 03:33:52 +08:00
Kelly Thomas 1dc8e7c05f Improve ClassDB information for some some signal parameters 2018-09-01 18:05:51 +08:00
Poommetee Ketson 6536834d42 [DOCS] complete Tree.get_drop_section_at_position and Tree.drop_mode_flags 2018-08-07 05:08:50 +07: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
Michael Alexsander Silva Dias 1260ed90bd Clarified what the Tree's signals "item_activated" and "item_double_clicked" do. 2018-02-20 13:11:06 -03: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