559c20aa2f
Improve AnimatedSprite2D description in the class reference
...
(cherry picked from commit de968baca9
2022-05-16 17:52:07 +02:00
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
9351bc4b1c
Fixed awkwardly named AnimatedSprite Setters.
...
(cherry picked from commit 0c06ed98fb
2021-12-10 17:57:39 +01:00
3ac2999f22
Replace Godot docs URL with `$DOCS_URL` in XML class reference
2021-11-15 17:22:47 +01:00
14c366ddd7
Bump version to 3.5-beta
2021-11-05 16:10:17 +01:00
f0b37b1519
doc: Point URLs to 3.4 version of the online docs
2021-08-12 17:08:10 +02: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
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
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
ef7675a053
Document support for normal and specular maps in AnimatedSprite2D
...
This closes #38509 .
(cherry picked from commit 8d0099f5fc
2020-09-01 21:00:58 +02:00
3b080845a8
Link to 2D Sprite animation tutorial in relevant class documentations
...
(cherry picked from commit 6d62e8b917
2020-08-25 12:58:31 +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
efd55631e2
doc: Sync classref with current source
2019-07-15 20:45:30 +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
ece6d37eef
Improved the AnimatedSprite docs; added description to speed_scale.
2019-05-07 22:48:39 -04:00
ab4705a807
Merge pull request #28125 from KoBeWi/code_true_code
...
Consistently wrap booleans in [code]
2019-04-22 11:59:16 +02:00
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
b0846f60c9
Consistently wrap booleans in [code]
2019-04-17 17:13:00 +02:00
09e94aa087
doc: Sync classref with current source
2019-04-15 14:49:41 +02:00
9d4093a21d
Merge pull request #27153 from YeldhamDev/animsprite_backwards
...
Make AnimatedSprite able to play backwards
2019-04-05 15:47:30 +02:00
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
4a2c433028
Make AnimatedSprite able to play backwards
2019-03-17 04:03:23 -03:00
6cdcde7114
doc: Add missing commas after "If true/false"
2018-12-20 13:47:12 +01: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
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
e28cdc4654
doc: Update version string in XML
2018-01-13 11:43:42 +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
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
a2f504c728
Added Documentation for Sprite3D, AnimatedSprite3D and SpriteBase3D etc.
2017-10-07 19:07:21 +02:00
129a37421d
[DOCS] Update AnimatedSprite class ref
2017-09-26 22:56:16 -07: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
Megamega53
Hugo Locurcio
Anilforextra
Rémi Verschelde
Aaron Franke
Sean Heffernan
Ken Paulson
Tomasz Chabora
Michael Alexsander Silva Dias
Grosskopf
Chris Bradfield
Juan Linietsky