asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
33661 commits 1 branch 0 tags 2.2 GiB
Commit graph

40 commits

Author SHA1 Message Date
Hugo Locurcio
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
Haoyu Qiu
bb1eb84da4 Alpha channel indicates opacity, not transparency 2021-12-24 16:52:32 +08:00
Yuri Sizov
ebd8101546 Sort and group theme properties in docs, improve formatting for theme and enums 2021-12-01 22:48:17 +03:00
Rémi Verschelde
14c366ddd7
Bump version to 3.5-beta 2021-11-05 16:10:17 +01:00
Rémi Verschelde
c7eb3d25e7
doc: Fix style inconsistencies for [b]Note:[/b] paragraphs 
(cherry picked from commit 788b3aa27a)
 2021-10-06 09:29:32 +02:00
Yuri Sizov
dd2a01cbbe Add usability notes to ColorPicker and ColorPickerButton descriptions 
Co-authored-by: follower <follower@rancidbacon.com>
 2021-09-25 02:21:39 +03:00
Yuri Sizov
fcbe5a3fde Add theme item descriptions to the online documentation 2021-08-06 18:20:51 +03:00
Rémi Verschelde
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
Rémi Verschelde
c3272997cd
doc: Update classref headers with 3.4 version 2021-04-26 13:15:29 +02:00
Rémi Verschelde
1aba997d75
doc: Sync classref with 3.3 version bump 2021-03-23 13:40:34 +01:00
Aaron Franke
069ed4ec63
Link to demos from within the class reference 
(cherry picked from commit 439be614f4)
 2020-10-19 16:10:01 +02:00
Tomasz Chabora
3739f03d98 Add LOTS of missing docs 
(cherry picked from commit e103f21a40)
 2020-03-13 17:26:30 +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
Chris Bradfield
72b43d5ed6 [DOC] Fill in various missing method/member descriptions. 2019-10-06 16:26:15 -07:00
Rémi Verschelde
79298face0 doc: Sync classref with current source 2019-10-01 10:58:48 +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
Hugo Locurcio
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
Rémi Verschelde
5e21310343 doc: Sync classref with current source 2019-06-24 10:39:59 +02:00
Rémi Verschelde
bb0aeb4874
Merge pull request #28659 from KoBeWi/rainbow_mode 
Add HSV mode to color picker
 2019-06-19 12:41:51 +02:00
Tomasz Chabora
86e4677fb4 Add HSV mode to color picker 2019-05-28 18:00:52 +02:00
Sean Heffernan
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
Rémi Verschelde
c991379b81 doc: Sync classref with current source 2019-04-30 14:23:59 +02:00
Rémi Verschelde
6af69f851a doc: Drop unused <demos> tag 2019-04-19 11:03:46 +02:00
Rémi Verschelde
39c868171e doc: Bump version to 3.2 2019-04-01 12:33:56 +02:00
Rémi Verschelde
6cdcde7114 doc: Add missing commas after "If true/false" 2018-12-20 13:47:12 +01:00
Rémi Verschelde
d030c17d5e doc: Sync classref with current source 2018-12-13 15:12:25 +01:00
lupoDharkael
e19520e8fe ColorPicker: extend access to presets from gds 2018-10-24 01:07:33 +02:00
luz.paz
08bde5b2de Misc. typos 
Found via `codespell -q 3 -I ../godot-word-whitelist.txt --skip="./thirdparty,*.po"`
 2018-09-12 21:39:17 -04:00
Chris Bradfield
23b7edb214 [DOCS] Updates to assorted class descriptions. 2018-08-17 14:55:19 -07:00
Rémi Verschelde
391e46830f doc: Sync classref with current source 
Fix various missing arguments in bindings.
 2018-07-26 11:56:21 +02:00
Chaosus
cf38270ef7 Increase settings apply speed and added deferred color apply 2018-05-31 11:33:36 +03: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
Bojidar Marinov
ad79c70300
Update docs 
[ci skip]
 2018-01-12 00:58:22 +02: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
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
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