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
d2c0ee700a
Update documentation for Control rect_pivot_offset to include rotation
2022-03-15 10:28:45 +00:00
08c3e00b95
Merge pull request #55355 from ConteZero/drag_and_drop_3.x
2022-03-14 08:43:22 +01:00
4167e98088
Add drag and drop to TextEdit, LineEdit, RichTextLabel
2022-03-14 08:15:25 +01:00
df13466139
Add type variations to Theme
2022-02-17 15:24:10 +03:00
46f65f9d79
Improve description of mouse_exited signal
...
(cherry picked from commit 4eec0032ea
2022-01-12 17:28:46 +01:00
e805ec8574
Merge pull request #54871 from timothyqiu/remove-theme-override
...
[3.x] Add methods to remove theme overrides
2022-01-11 20:16:05 +01:00
4f284893a6
Document get_minimum_size not called in some nodes
...
(cherry picked from commit 7d5ee8f694
2021-12-21 12:11:14 +01:00
b1153f8829
Fix broken links in Class Reference
2021-12-10 21:07:21 +08:00
3ac2999f22
Replace Godot docs URL with `$DOCS_URL` in XML class reference
2021-11-15 17:22:47 +01:00
936832d59c
Add methods to remove theme overrides
2021-11-11 18:23:37 +08:00
14c366ddd7
Bump version to 3.5-beta
2021-11-05 16:10:17 +01:00
98cf645258
Expose API to retrieve Theme's default font
2021-10-04 17:44:53 +03:00
370fa82b2c
Add note that for _gui_input(event) event position is relative to the control origin
...
(cherry picked from commit 824259aca0
2021-09-27 17:57:50 +02:00
f0b37b1519
doc: Point URLs to 3.4 version of the online docs
2021-08-12 17:08:10 +02:00
71ec6dba67
Improve Control's theme item methods documentation
2021-08-06 22:31:58 +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
94f79fa474
Document caveats with Control's `mouse_entered`/`mouse_exited` signals
...
(cherry picked from commit 37c1cbdcb2
2021-07-26 13:36:37 +02:00
6d58ea6ce7
Fix doc typos
...
This pull request fixes an assortment of typos and improves conciseness in `Animation`, `Area2D`, `Array`, `ArrayMesh`, `Control`, `Directory`, `EditorPlugin`, `Engine`, and `OS`.
(cherry picked from commit 9a72b0d3d0
2021-07-24 01:06:38 +02:00
80e1585a6e
Style: Cleanup uses of double spaces between words
...
Or after punctuation. Tried to leave third-party stuff alone, unless it has
been heavily modified for Godot.
(cherry picked from commit c1c76850cb
2021-06-07 12:06:59 +02:00
c3272997cd
doc: Update classref headers with 3.4 version
2021-04-26 13:15:29 +02:00
ed44e2806f
doc: Fix markup issues in classref
2021-04-07 11:52:44 +02:00
015973df04
doc: Make all tutorial links point to 3.3 branch of docs
2021-03-26 10:43:43 +01:00
3b0cf34299
Control: Expose pass_on_modal_close_click
2021-03-25 18:29:41 +01:00
1aba997d75
doc: Sync classref with 3.3 version bump
2021-03-23 13:40:34 +01:00
7df977c3ed
Fix crash during drag if user freed the drag preview
2021-02-27 15:16:06 +01:00
38a94ce2bc
Reference the control gallery image in the Control class documentation
...
Like the Tween cheatsheet or Color constants cheatsheet, this references
a "cheatsheet" image from the documentation repository.
(cherry picked from commit 200f1cf015
2021-02-02 13:02:46 +01:00
349f25429b
Exposed find_next_valid_focus and find_prev_valid_focus.
...
(cherry picked from commit 3e94c23fa5
2021-01-26 17:00:16 +01:00
05143ca39a
Tooltips: Improve code clarity and docs
...
The return type for `_make_custom_tooltip` is clarified as Control, and users
should make sure to return a visible node for proper size calculations.
Moreover in the current master branch, a PopupPanel will be added as parent
to the provided tooltip to make it a sub-window.
Clarifies documentation for `Control._make_custom_tooltip`, and shows how to
use the (until now undocumented) "TooltipPanel" and "TooltipLabel" theme types
to style tooltips.
Fixes #39677 .
(cherry picked from commit c5d8dafec4
2020-11-11 15:30:56 +01:00
150f9ce807
Merge pull request #42009 from Calinou/theme-node-type-3.2
...
Rename the `type` parameter to `node_type` in Theme and Control (3.2)
2020-10-20 15:58:41 +02:00
4287af5148
doc: Make docs.godotengine.org links point to 3.2 branch
2020-10-19 16:10:01 +02:00
069ed4ec63
Link to demos from within the class reference
...
(cherry picked from commit 439be614f4
2020-10-19 16:10:01 +02:00
e36587751f
Rename the `type` parameter to `node_type` in Theme and Control
...
This makes it clearer that it expects a node type as a string (such as "Label")
instead of a type like "TYPE_ARRAY". This is backwards-compatible since only
the name of the parameter is changed, not its order.
See https://github.com/godotengine/godot-proposals/issues/1495#issuecomment-691507839
2020-09-12 18:42:45 +02:00
6eee52e49b
Improve the documentation related to overriding GUI theme items
...
Overriding theme items is a common point of confusion.
Hopefully, these code samples should clear things up.
(cherry picked from commit 2a8bbda2a7
2020-08-31 15:29:43 +02:00
11bceb3d62
Document caveats related to Control scaling
...
This is a common topic of confusion. Clarifying its intended scope
should make things easier to understand.
(cherry picked from commit a36912b3cb
2020-07-24 10:31:56 +02:00
7607fafda1
Clarify documentation and indicate that rect_clip_content affects only CanvasItem based nodes.
...
Resolves #37683
(cherry picked from commit 3f19b5e0b3
2020-04-16 12:47:18 +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
378c4895ae
[DOCS] Corrections and clarifications to classref
2020-01-10 10:46:41 -08:00
e4b97b4614
[Doc] Added more details for set_drag_preview()
2019-11-07 12:43:04 +01:00
52e799b6d4
Code format for true/false/null to make documentation consistent
2019-11-02 12:14:15 +01: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
65d61d0360
doc: Sync classref with current source
2019-08-29 15:33:52 +02:00
1349e0e585
doc: Sync classref with current source
...
Fix wrong hyperlinks in Control and Tree.
2019-08-22 14:49:30 +02:00
592909db16
doc: Sync classref with current source
2019-08-13 12:35:50 +02:00
2dbc817b93
Complete the Control class documentation
2019-08-07 15:31:47 +02:00
efd55631e2
doc: Sync classref with current source
2019-07-15 20:45:30 +02:00
542489a866
DocData: Re-expose parametric setters and getters
...
Setters and getters have been hidden from the documentation when the matching
properties have been exposed, but some of them are parametric and require the
name or index of a given parameter to be used. So they need to be properly
documented with the type and name of the arguments they take.
For example, CPUParticles' `set_param(Parameter param, float value)`.
2019-07-04 14:08:16 +02:00
a78373ddc2
doc: Remove null default values that can't be determined
...
Applying #30187 .
2019-06-30 13:58:07 +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
Hugo Locurcio
Marcel Admiraal
Rémi Verschelde
ConteZero
Yuri Sizov
kobewi
Haoyu Qiu
Rémi Verschelde
skyace65
Nicholas Huelin
lupoDharkael
Delf Neumärker
Nils Reid
Aaron Franke
Markus Sauermann
Chris Bradfield
Anthony Rey
PouleyKetchoupp
luz.paz