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
1cf6d21f69
Make overridden properties link to parent definition
...
Co-authored-by: Josh DeGraw <joshmdegraw@gmail.com>
2021-12-03 17:48:49 +03:00
ebd8101546
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 22:48:17 +03:00
14c366ddd7
Bump version to 3.5-beta
2021-11-05 16:10:17 +01:00
7fe0dab69b
Add focus font color to Button and derivatives
2021-10-26 17:40:51 +03:00
2401f1cf65
Add warnings to methods that give access to internal nodes
2021-10-10 23:10:07 +03:00
fcbe5a3fde
Add theme item descriptions to the online documentation
2021-08-06 18:20:51 +03:00
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
c3272997cd
doc: Update classref headers with 3.4 version
2021-04-26 13:15:29 +02:00
1aba997d75
doc: Sync classref with 3.3 version bump
2021-03-23 13:40:34 +01:00
c33373b80a
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.
(cherry picked from commit 038baede5a
2020-09-24 14:43:12 +02:00
727bce727b
OptionButton.xml word order fix
...
Change word order of 'Emitted the when...' into 'Emitted when the...'
(cherry picked from commit 8f082d63c6
2020-08-31 15:29:44 +02:00
5d9108c9c6
Fix OptionButton docs godotengine#36803
...
* item_selected and item_focused docs incorrectly had 'id' as the parameter. Changed to
'index'.
* Fix parameter name in ADD_SIGNAL callin code.
(cherry picked from commit a8de034f78
2020-04-16 11:45:19 +02:00
11f012d2db
Completes doc for button classes
...
(cherry picked from commit db42d5ddff
2020-02-06 13:02:08 +01: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
575a1dc9cf
Docs: OptionButton
...
Complete the documentation and make some existing descriptions a bit
clearer.
Co-Authored-By: Hugo Locurcio <hugo.locurcio@hugo.pro>
2019-12-17 16:45:18 -06: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
b397bcf4a1
Run doctool after overridden properties changes
2019-09-04 15:26:08 +03:00
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
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
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
426bcc9941
Change "Return" to "Returns" where necessary in XML documentation
...
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
2019-05-23 21:11:24 -07:00
30da18c01a
doc: Sync classref with current source
2019-05-15 12:51:58 +02:00
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
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
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
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
7a79eee523
Expose OS::get_current_video_driver to scripting languages
2019-02-16 14:41:07 +01:00
7051685a77
Fixes differences between docs and item_selected and item_focused signals in optionbutton
...
Description in docs about item_selected and item_focused signals in optionbutton is fixed to match the real behaviour. Also, get_item_index function is added.
2019-02-11 08:52:09 -03:00
3d9deda8b3
Sync classref with current source
2018-05-12 09:38:00 +02:00
72aa87758a
Update classref and docs, fix missing parameters' name
2018-04-11 10:20:22 +07:00
cb7fe2c793
doc: Sync classref with current source
2018-04-10 10:12:42 +02: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
096b5a65c6
Added "get_popup" method for OptionButton and minor changes.
2017-12-25 13:49:27 -02:00
624a2b08f3
doc: Sync classref after a496dd4d, removing NOEDITOR properties from doc
2017-12-07 08:29:38 +01: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
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
a4005221f5
doc: Sync classref with current source
...
[ci skip]
2017-09-13 08:53:01 +02:00
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
Rémi Verschelde
Yuri Sizov
Rémi Verschelde
Hugo Locurcio
Andreas Gustafsson
Zak Grumbles
Haoyu Qiu
James Westman
Bojidar Marinov
Sean Heffernan
Ignacio Etcheverry
azagaya
Poommetee Ketson
Michael Alexsander Silva Dias
Juan Linietsky