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
85b4848ca8
Merge pull request #54188 from Rubonnek/increase_var_arg_max_3x
2022-03-08 13:10:48 +01:00
424dbf70af
Increase VARIANT_ARG_MAX to 8
2022-03-07 10:03:49 -05:00
4bd1ce49e6
Add note om when tween methods return false (3.x)
2022-01-08 21:51:30 -05:00
14c366ddd7
Bump version to 3.5-beta
2021-11-05 16:10:17 +01: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
c3272997cd
doc: Update classref headers with 3.4 version
2021-04-26 13:15:29 +02:00
596169d7df
class reference proofreading
...
(cherry picked from commit 8455e901f3
2021-03-26 09:49:07 +01:00
1aba997d75
doc: Sync classref with 3.3 version bump
2021-03-23 13:40:34 +01:00
68c273fb09
Tween.xml word order fix
...
Change the word order of '...the where...' into '...where the...'.
(cherry picked from commit 5181daaf9e
2020-06-24 22:52:05 +02:00
23ee40deff
Tweak Tween cheatsheet link formatting to avoid rST conversion bug
...
reStructuredText doesn't allow embedding links in bold/italic text.
(cherry picked from commit e8a2fa6b7d
2020-05-04 16:10:22 +02:00
bbd381c987
Add an easing/transition type cheatsheet to the Tween documentation
...
Related to https://github.com/godotengine/godot-docs/pull/3403 .
(cherry picked from commit 5972a9138e
2020-04-27 10:12:11 +02:00
3410dd3a9e
doc: Add a short AnimationPlayer versus Tween comparison
...
Many newcomers are confused about which one to choose for animating
properties. This should help clarify the situation with regards
to AnimationPlayer versus Tween.
(cherry picked from commit 810b1341ce
2020-02-06 13:02:08 +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
9f68626fb2
doc: Sync classref with current source
...
Also apply clang-format.
2019-12-13 10:41:06 +01:00
4eff13d768
doc: Markup fixes for enums and constants
2019-12-06 23:09:20 +01: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
bc82781f7d
doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinks
2019-06-27 13:49:36 +02:00
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
b2fcb40522
Merge pull request #27233 from Chaosus/tween_signal
...
Added signal for Tween emitted at full completion
2019-04-05 15:42:18 +02:00
a19e99aacb
Added signal for Tween emitted at completion
2019-04-03 10:35:26 +03:00
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
52125af7a0
mentioned possible use of property:component syntax
...
Referencing #26466 , added possible use of property:component syntax for functions like interpolate_property, follow_property,etc.. in the class description.
2019-03-03 01:26:54 +05:30
a15620c83e
doc: Fix wrong references found by Sphinx and new makerst.py
2019-01-07 12:15:01 +01:00
6cdcde7114
doc: Add missing commas after "If true/false"
2018-12-20 13:47:12 +01:00
22b7489ab1
doc: Fix invalid [enum] uses
2018-10-31 13:01:54 +01:00
eaac1e3b81
[Docs] Remove double-spaces from descriptions, as well a couple other small fixes
2018-09-23 16:13:30 -04:00
a164d593c0
[DOCS] get_indexed, tween
2018-08-11 08:48:37 -05:00
391e46830f
doc: Sync classref with current source
...
Fix various missing arguments in bindings.
2018-07-26 11:56:21 +02:00
d5bb6faac7
-Make sure that ProjectSettings are properly dumped when dumping docs.
...
-Documented all properties of project settings
Update documentation for ProjectSettings
2018-06-11 13:41:16 -03:00
3d9deda8b3
Sync classref with current source
2018-05-12 09:38:00 +02:00
d7218c742c
Rewrite Tween class reference.
2018-05-06 20:12:01 -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
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
4808dfb06b
doc: Sync with current source
2018-01-24 21:58:39 +01:00
e28cdc4654
doc: Update version string in XML
2018-01-13 11:43:42 +01:00
ad79c70300
Update docs
...
[ci skip]
2018-01-12 00:58:22 +02: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
15ada56d73
doc: Sync classref with current source
2017-11-24 09:16:27 +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
fc09e14366
classref: Sync with current source
...
Also fix hyperlink references to same class as per the guidelines.
[ci skip]
2017-10-22 12:56:17 +02:00
4c716f3623
[DOCS] Fix a few typos.
2017-10-14 12:45:49 +02:00
b1f2c31a36
doc: Sync classref with current source
...
Ensure that s/fixed_process/physics_process/ is handled properly.
[ci skip]
2017-10-11 23:55:04 +02:00
5ad9be4c24
Rename pos to position in user facing methods and variables
...
Rename user facing methods and variables as well as the corresponding
C++ methods according to the folloming changes:
* pos -> position
* rot -> rotation
* loc -> location
C++ variables are left as is.
2017-09-20 13:11:10 +02:00
a4005221f5
doc: Sync classref with current source
...
[ci skip]
2017-09-13 08:53:01 +02:00
Hugo Locurcio
Rémi Verschelde
Wilson E. Alvarez
skyace65
Rémi Verschelde
Paul Joannon
Andreas Gustafsson
Chaosus
psuhas77
LikeLakers2
Fluffel
Juan Linietsky
Chris Bradfield
Bojidar Marinov
Andreas Haas
letheed