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

50 commits

Author SHA1 Message Date
Hugo Locurcio
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
zacryol
123cfb4759 Update description of FileDialog filters property 
specify that multiple filetypes/extensions can be included in one filter within the
PackedStringArray, and provide an example
 2022-01-11 18:04:14 -07:00
kobewi
b403954e41 Improve FileDialog filters 2022-01-08 16:27:15 +01:00
Yuri Sizov
b3992f7e6e Make overridden properties link to parent definition 
Co-authored-by: Josh DeGraw <joshmdegraw@gmail.com>
 2021-12-03 17:47:22 +03:00
Yuri Sizov
397e56964d Sort and group theme properties in docs, improve formatting for theme and enums 2021-12-01 21:02:20 +03:00
Yuri Sizov
07725b611b Add warnings to methods that give access to internal nodes 2021-10-10 22:57:58 +03:00
Yuri Sizov
bf2839ea3e Add theme item descriptions to the online documentation 2021-08-04 22:27:10 +03:00
Rémi Verschelde
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
Michael Alexsander Silva Dias
0ff4095b36 Better format arguments in variant parser 2021-06-18 00:06:40 -03:00
bruvzg
b202a0dd2a
FileDialog: add Back/Forward buttons, add message for inaccessible folders. 2021-03-23 08:03:41 +02:00
Marcel Admiraal
7b293eddfb Rename unselect to deselect 2020-12-21 10:26:41 +00:00
umarcor
1ddb0e56ac doc/FileDialog: warn about access limitations in sandboxed apps 
Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
 2020-09-01 16:22:15 +02:00
Rémi Verschelde
1642effe5b
Merge pull request #39322 from dominiks/filedialog-title-doc 
Add note about automatic window title to FileDialog documentation.
 2020-06-15 13:22:25 +02:00
Michael Alexsander
637927f803 Add generic file icon and its modulation to the 'FileDialog' 2020-06-08 10:31:45 -03:00
dominiks
d2250a2320 Add note about automatic window title to FileDialog documentation. 2020-06-05 22:30:24 +02:00
Rémi Verschelde
e5033d3952 doc: Sync classref with DisplayServer/Window changes 2020-03-31 11:56:58 +02:00
Tomasz Chabora
e103f21a40 Add LOTS of missing docs 2020-03-13 16:35:03 +01:00
Rémi Verschelde
213a85521d doc: Sync classref with current source 
Handle removal of Pool*Array types and other recent changes.
 2020-02-18 14:02:02 +01:00
Rémi Verschelde
0e3d625737 doc: Sync classref with current source 
Lots of internal API changes and some docstrings were lost in the conversion.
I manually salvaged many of them but for all the rendering-related ones, an
additional pass is needed.

Added missing enum bindings in BaseMaterial3D and VisualServer.
 2020-02-12 12:37:13 +01:00
clayjohn
57e27683ba Update docs to version 4.0 2020-01-31 17:15:41 -08: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
Rémi Verschelde
a7ac8ec876 doc: Fix parsing of self-closing XML tags 
Follow-up to #31925, `<member />` tags just before `</members>` would cause
a parsing issue, and we'd never notice that we're no longer parsing members.

Also added space before closing `/>`.
 2019-09-24 13:34:05 +02:00
Bojidar Marinov
b397bcf4a1
Run doctool after overridden properties changes 2019-09-04 15:26:08 +03:00
Hugo Locurcio
e1b9004b0f
Rename FileDialog's folder icon custom color to folder_icon_modulate 
The custom color introduced in be8d569744
had the same name as the "folder" icon, which could cause conflicts
in the generated documentation.

The new name is also more self-explanatory.
 2019-08-21 18:43:01 +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
bc82781f7d doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinks 2019-06-27 13:49:36 +02:00
Rémi Verschelde
9a173e5814 doc: Fix formatting, typos and some descriptions in new docstrings 2019-06-15 00:11:41 +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
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
Michael Alexsander Silva Dias
4a91f94c13 Add undo-redo to the TileSet editor, and other improvements 2018-12-30 10:54:03 -02:00
Alexander Holland
e4b2a20cd6 Filled missing Doc for String and FileDialog 2018-10-12 04:46:24 +02:00
Juan Linietsky
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
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
5c7644d167
Merge pull request #13847 from YeldhamDev/filedialog_title 
Added "mode_overrides_title" property to FileDialog
 2017-12-09 15:48:19 +01:00
Rémi Verschelde
7d440d04aa doc: Sync classref with current source 2017-12-07 08:23:08 +01:00
Michael Alexsander Silva Dias
075edbc5ed Added "mode_overrides_title" property to FileDialog. 2017-12-03 00:04:47 -02:00
Rémi Verschelde
cb4c0c630f doc: Sync classref with current source 2017-11-27 23:37:47 +01:00
Rémi Verschelde
7dfba3cda9 doc: Fix enum tags thanks to 2bc6db6 2017-11-24 23:16:30 +01:00
Rémi Verschelde
92f07fefcd doc: Remove setters and getters now exposed via properties/members 2017-11-24 18:10:32 +01: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
Andreas Haas
4c716f3623
[DOCS] Fix a few typos. 2017-10-14 12:45:49 +02:00
Rémi Verschelde
a4005221f5 doc: Sync classref with current source 
[ci skip]
 2017-09-13 08:53:01 +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