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
2e3cbbcd11
Add method description to `PopupMenu`
...
This pull request adds a missing method description to `PopupMenu`.
This completes the documentation for `PopupMenu` and enhances usability by doing so.
Update doc/classes/PopupMenu.xml
Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
2021-07-08 07:34:14 -04:00
0ff4095b36
Better format arguments in variant parser
2021-06-18 00:06:40 -03:00
8455e901f3
class reference proofreading
2021-03-19 13:21:20 +01:00
0d1d719178
doc: Sync classref with current source
...
And fix various bogus bindings following previous PRs.
2021-02-19 14:39:14 +01:00
d78336c65e
[CTL] Add missing font outline drawing routines and theme constants.
2021-02-14 14:11:44 +02:00
fb01d057af
doc: Sync classref with current source
2021-01-28 11:26:37 +01: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
ca8c794d04
Added optional id parameter to `PopupMenu::add_separator`
2020-12-27 15:18:47 +03:00
383e8919e0
Add "font_color_separator" theme property to 'PopupMenu'
2020-12-03 11:36:03 -03:00
7e2c0ffd1a
[Complex Text Layouts] Add TextServer documentation. Update Font, CanvasItem, Theme and modified controls documentation.
2020-11-26 14:25:52 +02:00
3e0226515e
Rename ShortCut to Shortcut which is more grammatically correct
...
See https://github.com/godotengine/godot/issues/16863#issuecomment-685236980 .
2020-09-09 21:54:54 +02:00
926c282fd5
Updated PopupMenu documentation after merge of #41640 - PopupMenu rework
2020-09-02 10:19:57 +10:00
0b8cb945cf
doc: Sync classref with current source
2020-05-20 15:29:37 +02:00
bbdfc7353c
doc: Sync classref with current source
2020-05-11 13:23:39 +02:00
e5033d3952
doc: Sync classref with DisplayServer/Window changes
2020-03-31 11:56:58 +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
57e27683ba
Update docs to version 4.0
2020-01-31 17:15:41 -08:00
21dd35b611
Document theme_items of multiple classes
2020-01-27 02:15:37 +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
b81843ee6c
Complete docs for GraphEdit/Node and PopupMenu
2020-01-07 22:05:32 -03:00
ab11916822
[DOCS] Class reference typos and fixes.
2020-01-02 10:31:16 -08:00
52e799b6d4
Code format for true/false/null to make documentation consistent
2019-11-02 12:14:15 +01:00
d655a7c097
doc: Sync classref with current source
2019-10-11 08:45:03 +02:00
63a19df5e6
PopupMenu: Reorder add_* methods in more natural order
...
Also adds `add_icon_radio_check_shortcut` matching `add_icon_radio_check_item`,
binds them for scripting languages, and binds `add_multistate_item`.
2019-10-08 09:32:01 +02: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
91ecd7b6a6
Fix misc. source comment typos
...
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 `
2019-09-19 14:36:52 -04: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
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
316931998c
Document PopupMenu node.
2019-06-28 12:57:52 +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
cfb9709c10
doc: Sync classref with current source
2019-06-01 12:34:29 +02:00
64a88e8ef3
Merge pull request #28841 from KoBeWi/option_button_options
...
Improvements to incremental search
2019-06-01 11:47:06 +02:00
9de912caf5
Improvements to incremental search
2019-05-31 14:56:49 +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
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
f614f15506
doc: Misc formatting fixes
2019-02-10 13:30:48 +01:00
4ea3e4f551
doc: Sync classref with current source
2018-08-21 00:35:46 +02:00
391e46830f
doc: Sync classref with current source
...
Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
e3b77b24ac
Add ability to set submenu's popup delay time on mouse hovering
...
This allows to set delay time for the submenu to popup. Setting
this value low can increase responsiveness. If the popup menu is added
as a child of another (acting as a submenu), it will inherit the delay
time of the parent menu item.
2018-07-09 18:37:41 +03:00
d5bb6faac7
-Make sure that ProjectSettings are properly dumped when dumping docs.
...
-Documented all properties of project settings
Update documentation for ProjectSettings
2018-06-11 13:41:16 -03: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
b964a9e678
Add support for radio-looking items with icon
...
Letting users of `PopupMenu` use them. `OptionButton` was one of those interested and is updated in this commit.
Fixes #18063 .
2018-04-09 19:55:54 +02:00
ab3b1d9f3e
Add radio-button-looking entries to PopupMenu
...
They work exactly the same as current checkbox-decorated items, but in order to preserve compatibility, separate methods are used, like `add_radio_check_item()`. The other option would have been to add a new parameter at the end of `add_check_item()` and the like, but that would have forced callers to provide the defaults manually.
`is_item_checkable()`, `is_item_checked()` and `set_item_checked()` are used regardless the item is set to look as check box or radio button.
Keeping check in the name adds an additional clue about these facts.
Closes #13055 .
2018-03-27 19:19:45 +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
9f479f096c
Fix typos in code and docs with codespell
...
Using v1.11.0 from https://github.com/lucasdemarchi/codespell
2018-01-18 22:01:42 +01:00
e28cdc4654
doc: Update version string in XML
2018-01-13 11:43:42 +01:00
ad79c70300
Update docs
...
[ci skip]
2018-01-12 00:58:22 +02:00
aa6772d7ab
Revert property changes in "[DOCS] AnimationPlayer new props, members/methods"
...
This partially reverts commits e79456519d2d07fe2920Fixes #14602 .
2017-12-14 00:36:41 +01:00
9888a56639
Change statable to multistate, remove extra separator
2017-12-12 09:41:17 +07:00
2b41afb30e
Fix wrong return value in some virtual method bindings
2017-12-10 15:34:08 +01: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
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
Nick Huelin
Michael Alexsander Silva Dias
Paul Joannon
bruvzg
Marcel Admiraal
Yuri Roubinsky
Hugo Locurcio
Eric M
clayjohn
Tomasz Chabora
Chris Bradfield
PouleyKetchoupp
luz.paz
Bojidar Marinov
Zak
Sean Heffernan
Andrii Doroshenko (Xrayez)
Juan Linietsky
Poommetee Ketson
Pedro J. Estébanez