26614a37b8
Mention `keep_pressed_outside` caveat in the BaseButton documentation
...
This closes #37790 .
(cherry picked from commit e799dc954e
2020-04-16 12:57:22 +02: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
4eff13d768
doc: Markup fixes for enums and constants
2019-12-06 23:09:20 +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
b397bcf4a1
Run doctool after overridden properties changes
2019-09-04 15:26:08 +03:00
efd55631e2
doc: Sync classref with current source
2019-07-15 20:45:30 +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
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
a72552367e
Merge pull request #25453 from nekomatata/button-keep-pressed-option
...
Add option to keep button pressed when moving cursor outside while pressing
2019-05-01 10:30:40 +02:00
ab4705a807
Merge pull request #28125 from KoBeWi/code_true_code
...
Consistently wrap booleans in [code]
2019-04-22 11:59:16 +02:00
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
b0846f60c9
Consistently wrap booleans in [code]
2019-04-17 17:13:00 +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
43bd28bc14
Option for BaseButton to keep button down when moving the pointer outside while pressed
2019-04-03 14:19:33 +02:00
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
c8aa85189a
EditorHelp, makerst: Improve enum ref resolving and constant ref support
...
Enum reference resolving will now search in the @GlobalScope if no class is specified and the enum cannot be resolved in the current class.
Added support for constant references in EditorHelp, e.g.: [constant KEY_ENTER] or [constant Control.FOCUS_CLICK]. It supports enum constants (the enum name must not be included).
2019-03-29 23:40:31 +01:00
57b82873fb
Docs: fix arg name of toggled signal in BaseButton
...
arg was renamed in #15530 but the description wasn't updated
2019-01-11 09:51:39 +07:00
a15620c83e
doc: Fix wrong references found by Sphinx and new makerst.py
2019-01-07 12:15:01 +01:00
26fddb77be
doc: Fix wrong references found by new makerst.py
...
Thanks @PJB3005
2019-01-07 10:06:12 +01:00
6cdcde7114
doc: Add missing commas after "If true/false"
2018-12-20 13:47:12 +01:00
412612abfc
doc: Sync classref with current source
2018-11-23 01:06:24 +01:00
d2b890ede5
BaseButton: add shortcut_in_tooltip
...
This flag disables the input related information in the tooltip.
It is exposed as a member variable in gdscript.
2018-11-19 23:48:05 +01:00
b150ceb62c
Update class documentation xml
2018-10-07 21:57:26 +08:00
ed69345a19
Add a binary mask to allow configuration of which mouse buttons the BaseButton will respond to.
2018-03-13 23:59:53 +01: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
4b6bef6524
Fix signal arguments shadowing member variables
...
Fixes #10212 .
2018-01-09 16:51:19 +01:00
7dfba3cda9
doc: Fix enum tags thanks to 2bc6db6
2017-11-24 23:16:30 +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
b0ac316dc9
[DOCS] BaseButton
2017-10-23 00:17:02 +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
Hugo Locurcio
Rémi Verschelde
Tomasz Chabora
Bojidar Marinov
Sean Heffernan
PouleyKetchoupp
Ignacio Etcheverry
Poommetee Ketson
lupoDharkael
Kelly Thomas
Goutte
Jerome67000
Juan Linietsky