16fd1c421e
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:32:31 +02:00
015973df04
doc: Make all tutorial links point to 3.3 branch of docs
2021-03-26 10:43:43 +01:00
1aba997d75
doc: Sync classref with 3.3 version bump
2021-03-23 13:40:34 +01:00
0974cf15f6
Documentation: Correct CanvasItem.draw_string position description.
...
Also add height warnings to Font.get_char_size and Font.get_string_size
2021-02-19 18:33:27 +10:30
7dd5de5a57
Clarify what the "item_rect_changed" signal does
...
(cherry picked from commit 120ef02ca3
2020-11-11 15:30:55 +01:00
4028414e0e
Revert "Made toplevel a property for Node3D and CanvasItem"
...
This reverts commit a726d011d5
2020-10-19 16:58:56 +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
a726d011d5
Made toplevel a property for Node3D and CanvasItem
...
(cherry picked from commit 85a8dbb7b6
2020-10-01 16:00:47 +02:00
bd76fcd43b
Add an example to the `CanvasItem.draw_string()` documentation
...
This closes https://github.com/godotengine/godot-docs/issues/3374 .
(cherry picked from commit 0c7735be5b
2020-07-29 18:23:45 +02:00
36b746d903
Merge pull request #40822 from Calinou/doc-canvasitem-draw_multiline_colors-antialiased
...
Document `CanvasItem.draw_multiline_colors()` not supporting width and AA
2020-07-29 12:45:17 +02:00
39ec3ad2e5
Document `CanvasItem.draw_multiline_colors()` not supporting width and AA
2020-07-29 11:45:49 +02:00
451648c34d
Improve visibility documentation for CanvasItem and Node3D
...
This closes https://github.com/godotengine/godot-docs/issues/3840 .
(cherry picked from commit 27b09dfc44
2020-07-28 00:53:16 +02:00
bb753aaf17
Clarify that angles must be specified as radians in the documentation
...
This closes #36356 .
(cherry picked from commit cae5260dab
2020-04-20 11:53:40 +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
ba177ccaec
doc: Misc updates for AnimationNode* and others
...
- Add some missing descriptions.
- Add links to tutorials for ARVR and AnimationTree.
- Style fixes.
- Engine changes:
* Make `AnimationNodeTransition.input_<number>` properties internal
so that they don't appear in the docs. They still appear in the
inspector based on the actual number of inputs requested.
* Drop unimplemented `CPUParticles.flatness`. It's only used for 3D
particles in `ParticlesMaterial`, and thus only relevant for
`CPUParticles3D`.
2020-01-23 12:37:33 +01:00
378c4895ae
[DOCS] Corrections and clarifications to classref
2020-01-10 10:46:41 -08:00
d93201b27f
Merge pull request #33229 from Jummit/document-force_update_transform
...
Document force_update_transform
2019-11-01 14:03:01 +01:00
2166437869
document force_update_transform
2019-11-01 10:37:39 +01:00
aa0fa6b14f
doc: Sync classref with current source
2019-10-26 16:40:41 +02:00
efd55631e2
doc: Sync classref with current source
2019-07-15 20:45:30 +02:00
2491c87f86
Add `width` and `antialiased` parameters to CanvasItem `draw_rect()`
...
This also removes some duplicated editor code which is now obsoleted
by the new parameters in `draw_rect()`.
2019-07-09 20:30:18 +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
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
1cfa74bf92
Improve the CanvasItem documentation
...
This makes it clear that line width and antialiasing in
`draw_multiline()` aren't implemented yet (see #16448 ).
2019-05-14 09:10:00 +02:00
325f6c6581
Added inspector plugin documentation.
...
Fixed plugin bindings.
2019-04-23 16:39:09 -03:00
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
09e94aa087
doc: Sync classref with current source
2019-04-15 14:49:41 +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
6cdcde7114
doc: Add missing commas after "If true/false"
2018-12-20 13:47:12 +01:00
c2e165955f
Updated documentation to visible property in CanvasItem, closes #20809
2018-12-14 11:36:53 -03:00
d030c17d5e
doc: Sync classref with current source
2018-12-13 15:12:25 +01:00
3f7ae10843
Fixed CanvasItem.draw_multimesh() binding.
2018-12-05 01:29:21 +01:00
5f8af252e8
doc: Use HTTPS for docs.godotengine.org and point to latest branch
...
Fixes #23509 .
2018-11-05 08:46:27 +01:00
d286e98fd1
Small documentation clarification added to CanvasItem.
2018-09-16 21:44:37 +03:00
c320d9394d
doc: Sync classref with current source
2018-09-11 00:18:21 +02:00
98b59cf2a3
Add support for tutorial links to makerst.py
...
Also change the <tutorials> structure to make use of individual <link> tags
2018-06-12 17:40:24 +02:00
3d9deda8b3
Sync classref with current source
2018-05-12 09:38:00 +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
eb63f7b071
[DOCS] Sync classref with current source
2018-02-25 15:14:25 +07:00
3c7a39b40c
doc: Update version string in header
2018-02-19 10:46:33 +01:00
f2e3825616
doc: Fix references to online tutorials after godotengine/godot-docs#1015
2018-01-25 09:03:59 +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
f4d67433e7
More precise description for is_visible_in_tree
2018-01-22 16:22:17 +01:00
6c46787749
doc: Replace some more "val" with "value" + sync
2018-01-17 10:43:23 +01:00
Rémi Verschelde
Luke Hubmayer-Werner
SirQuartz
Aaron Franke
Duroxxigar
Hugo Locurcio
Chris Bradfield
Jummit
Sean Heffernan
Juan Linietsky
Ignacio Etcheverry
MrCdK
Jared
robojumper
Poommetee Ketson
PetePete1984