cc0eebd9d8
Validate `code` tags for class and member references
...
This commit also adds means to manually disable warnings
in `code` tags where it's a false positive with the new
`skip-lint` attribute.
Warnings are now enabled on CI to prevent future errors.
2023-10-03 15:48:31 +02:00
81064cc239
Doctool: Remove version attribute from XML header
...
We don't use that info for anything, and it generates unnecessary diffs
every time we bump the minor version (and CI failures if we forget to
sync some files from opt-in modules (mono, text_server_fb).
2023-07-06 10:08:21 +02:00
346f1ab86b
Bump version to 4.2-dev
...
Keep on waitin'
2023-07-05 22:07:03 +02:00
1c1524a651
Bump version to 4.1-dev
...
Can't stop, won't stop, they said, huh?
2023-03-01 01:44:37 +01:00
75330887d7
Implement blending audio feature to AnimationTree
2023-01-28 20:08:29 +09:00
9b345e793a
[doc] Use "param" instead of "code" to refer to parameters (8)
2022-08-12 14:00:25 -04:00
c5d7115038
Rename the argument tag to param in XML documentation
2022-08-08 22:34:31 +03:00
eedb729771
AudioStreamPlayer: Clarify that no validation is made on 'bus' name
...
Supersedes #39605 .
Fixes #39585 .
2022-07-08 09:33:25 +02:00
b68dd2e189
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-02-15 00:03:31 +01:00
6c1bd4d227
Replace Godot docs URL with `$DOCS_URL` in XML class reference
2021-11-15 13:02:21 +01:00
0e3cab41eb
Add polyphony to Audio Stream Player nodes
2021-09-07 09:44:39 -07:00
7adf4cc9b5
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.
2021-07-30 15:29:52 +02:00
6710ad1737
Let var2str display StringName with correct sigil
2021-06-10 16:30:28 -05:00
b90adec417
Improve the AudioStreamPlayer(2D/3D) class descriptions
2021-05-05 20:39:36 +02:00
439be614f4
Link to demos from within the class reference
2020-10-01 23:57:21 -04:00
c4903a603b
Add link titles for all links in the class reference
...
This makes them display in a nicer way in the editor help.
(The title will display instead of the full URL.)
2020-08-31 14:22:07 +02:00
4751dee7f4
Improve `pitch_scale` descriptions in AudioStreamPlayer documentation
...
This closes #29439 .
Co-authored-by: Cheeseness <contact@jbushproductions.com>
2020-04-26 16:37:57 +02:00
fea37cfb52
doc: Sync classref with StringName/Callable changes
2020-02-22 14:59:09 +01:00
57e27683ba
Update docs to version 4.0
2020-01-31 17:15:41 -08: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
508e624b87
Complete documentation of various classes
2020-01-10 14:14:07 +01:00
4eff13d768
doc: Markup fixes for enums and constants
2019-12-06 23:09:20 +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
c991379b81
doc: Sync classref with current source
2019-04-30 14:23:59 +02:00
11fb4ffbf8
Added docs to AudioStreamPlayer for get_mix_time
2019-04-27 14:11:39 -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
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
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
5f8af252e8
doc: Use HTTPS for docs.godotengine.org and point to latest branch
...
Fixes #23509 .
2018-11-05 08:46:27 +01:00
512ae49f7d
Added description and measurement
2018-07-31 14:20:27 -05:00
391e46830f
doc: Sync classref with current source
...
Fix various missing arguments in bindings.
2018-07-26 11:56: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
83c4fc2c88
Added a description to the picth_scale property in the AudioStreamPlayer classes.
2018-05-04 13:31:11 +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
fee29570d0
doc: Sync classref with current source
2018-02-19 10:47:16 +01: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
03475ba197
Filled tutorial field in most relevent classes.
...
Added tutorial display in doc.
2018-01-15 18:41:13 -03:00
e28cdc4654
doc: Update version string in XML
2018-01-13 11:43:42 +01: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
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
3ac7cc9e57
updated AudioStream docs and added AudioServer docs
2017-10-11 00:51:59 +02:00
Yuri Sizov
Rémi Verschelde
Silc Renew
Andy Maloney
Hugo Locurcio
Ellen Poe
Jonathan Gollnick
Aaron Franke
clayjohn
Tomasz Chabora
Juan Linietsky
Jason Anderson
robojumper
Nobelix
Grosskopf