Rémi Verschelde
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
Rémi Verschelde
1aba997d75
doc: Sync classref with 3.3 version bump
2021-03-23 13:40:34 +01:00
Rémi Verschelde
400a780050
Revert "Allow Area2D and 3D mouse events without a collision layer"
...
This reverts commit 15850687a8
.
2020-07-27 22:46:04 +02:00
Rémi Verschelde
2244841729
doc: Sync classref with current source
2020-07-15 12:56:16 +02:00
Tomasz Chabora
15850687a8
Allow Area2D and 3D mouse events without a collision layer
...
Co-authored-by: Tomasz Chabora <kobewi4e@gmail.com>
2020-07-11 11:14:12 +01:00
Rémi Verschelde
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
Tomasz Chabora
c09b9c488f
Complete documentation of some more classes
2020-01-14 13:19:39 +01:00
FlamyAT
9a84cef4fc
Documents the need for input_pickable in _input_event
...
Update CollisionObject2D.xml
Added member tags to missing docs
2019-07-22 15:12:49 +02:00
Rémi Verschelde
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
lopho
da73bcca6f
Document CollisionObject2D pickable requires collision_layer
...
Documents CollisionObject2D mouse_entered, mouse_exited and input_event requiring at least one collision_layer to be set.
2019-05-02 15:43:28 +02:00
Rémi Verschelde
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
Rémi Verschelde
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
Rémi Verschelde
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
Ignacio Etcheverry
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
Rémi Verschelde
433b8ee526
doc: Sync classref with current source
2019-01-26 22:21:53 +01:00
Rémi Verschelde
6cdcde7114
doc: Add missing commas after "If true/false"
2018-12-20 13:47:12 +01:00
Kelly Thomas
1dc8e7c05f
Improve ClassDB information for some some signal parameters
2018-09-01 18:05:51 +08:00
Kelly Thomas
29f2571662
update class docs
2018-08-31 22:35:15 +02:00
Rémi Verschelde
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
Rémi Verschelde
3c7a39b40c
doc: Update version string in header
2018-02-19 10:46:33 +01:00
Rémi Verschelde
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
Rémi Verschelde
e28cdc4654
doc: Update version string in XML
2018-01-13 11:43:42 +01:00
Will Nations
a9c9499c73
[DOCS] CanvasItem/Material/Layer, ClassDB, CollisionObject(2D)
2017-12-07 22:12:01 -06:00
Rémi Verschelde
92f07fefcd
doc: Remove setters and getters now exposed via properties/members
2017-11-24 18:10:32 +01:00
Rémi Verschelde
bc75fae579
doc: Update header version for 3.0-beta
2017-11-24 09:16:52 +01:00
Rémi Verschelde
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
Rémi Verschelde
b302084395
makerst: Fix rst-ization of members and escaping of [Class]s
...
Fixes #11517 .
2017-10-21 12:33:52 +02:00
Chris Bradfield
29f37120dd
[DOCS] Update CollisionObject/CollisionObject2D class ref
2017-09-23 19:58:48 -07:00
Rémi Verschelde
a4005221f5
doc: Sync classref with current source
...
[ci skip]
2017-09-13 08:53:01 +02:00
Juan Linietsky
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