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
c3272997cd
doc: Update classref headers with 3.4 version
2021-04-26 13:15:29 +02:00
4d7f642fb3
Improve some argument names for core types
2021-04-23 15:34:24 +02:00
1aba997d75
doc: Sync classref with 3.3 version bump
2021-03-23 13:40:34 +01:00
9c83b8ed70
[3.2] Improve comments in Color documentation
2020-11-14 04:56:18 -05:00
069ed4ec63
Link to demos from within the class reference
...
(cherry picked from commit 439be614f4
2020-10-19 16:10:01 +02:00
28be48fb67
Reference the Color constants cheatsheet in the class reference
...
(cherry picked from commit de49085567
2020-09-29 08:54:44 +02:00
3ab5183ffa
[3.2] Backport core documentation changes to 3.2
...
Also add AABB.abs()
2020-07-21 21:22:54 -04:00
9889641bae
Document how Vector2, Vector3 and Color behave in a boolean context
...
See #39731 .
(cherry picked from commit 227f12478d
2020-06-21 21:44:02 +02:00
acb83db1d1
doc: Sync classref with current source
2020-05-25 17:00:22 +02:00
27989ae8f8
Add reference of Color8 function to Color class documentation
...
(cherry picked from commit 06aeff3044
2020-04-16 12:47:18 +02:00
df2a2ae0fc
DocData: Fix serialization of Variant default values
...
Co-authored-by: Bojidar Marinov <bojidar.marinov.bg@gmail.com>
(cherry picked from commit 788765709d
2020-03-09 11:36:57 +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
cbdbfb00ca
doc: Document named color constants
...
Busywork but it's good for our completion rate :)
2020-01-26 12:08:16 +01:00
c4745c96d7
Remove unnecessary extra spaces before comments in code examples.
2020-01-23 14:41:49 -03:00
3231fca934
Add docs for is_equal_approx on structures
2019-11-30 16:52:27 -05:00
1f76229378
doc: Sync classref with current source
2019-11-08 08:33:48 +01: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
024d595850
Fixing returned alpha component for inverted method
...
See `core/color.cpp:217`, alpha channel is not changed.
2019-06-08 01:44:25 +02:00
3a365c1fc0
doc: Sync classref with current source
2019-05-28 18:08:13 +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
e588c24168
doc: Fix formatting in code blocks
2018-12-14 09:37:19 +01:00
7bc11505b1
[DOCS] Classref updates: Color, RigidBody*
2018-10-02 15:47:10 -07:00
eaac1e3b81
[Docs] Remove double-spaces from descriptions, as well a couple other small fixes
2018-09-23 16:13:30 -04:00
4ea3e4f551
doc: Sync classref with current source
2018-08-21 00:35:46 +02:00
ba974b8d1e
Allow some non-integer built-in constants in gdscript
2018-07-31 17:56:48 +02:00
391e46830f
doc: Sync classref with current source
...
Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
55d976467d
Expose 64-bit Color methods to GDScript and fix/update Color XML doc
2018-07-25 15:35:29 -05:00
41e9e5501b
Fix docs regarding Color.from_hsv hue range [0,360] -> [0,1]
...
Per changes in #17407
2018-05-11 18:57:11 +07: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
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
70bba4e62d
Fix bug in color doc
2018-01-24 23:39:36 +03:00
e28cdc4654
doc: Update version string in XML
2018-01-13 11:43:42 +01:00
feef8615d2
Add standardised color names to doc
2018-01-08 11:55:49 +01:00
bc75fae579
doc: Update header version for 3.0-beta
2017-11-24 09:16:52 +01:00
15ada56d73
doc: Sync classref with current source
2017-11-24 09:16:27 +01:00
8e4336a729
Add Color.lightened and Color.darkened (like LESS.css or SASS)
2017-11-21 21:48:11 +11: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
kleonc
Aaron Franke
Hugo Locurcio
Nannaquin
Michael Alexsander
Maxime Leroy
Chris Bradfield
LikeLakers2
Bernhard Liebl
Noshyaar
Chaosus
Jerome67000
Kyle Van Berendonck
Juan Linietsky