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
caf2c20655
Don't store and show current file/directory/path FileDialog properties
...
These properties are only useful at run-time, so they don't need
to be displayed in the editor and stored.
(cherry picked from commit 2ad6e11b78
2022-03-13 15:46:01 +01:00
8edc8a95b1
Improve FileDialog filters
...
(cherry picked from commit b403954e41
2022-01-12 17:33:16 +01:00
21526aa578
Update description of FileDialog `filters` property
...
specify that multiple filetypes/extensions can be included in one filter within the
PackedStringArray, and provide an example
(cherry picked from commit 123cfb4759
2022-01-12 17:28:07 +01:00
eac0d90c39
Merge pull request #55560 from pycbouh/docs-overridden-cross-linked-3.x
...
[3.x] Make overridden properties link to parent definition
2021-12-10 12:42:09 +01:00
1cf6d21f69
Make overridden properties link to parent definition
...
Co-authored-by: Josh DeGraw <joshmdegraw@gmail.com>
2021-12-03 17:48:49 +03:00
ebd8101546
Sort and group theme properties in docs, improve formatting for theme and enums
2021-12-01 22:48:17 +03:00
14c366ddd7
Bump version to 3.5-beta
2021-11-05 16:10:17 +01:00
2401f1cf65
Add warnings to methods that give access to internal nodes
2021-10-10 23:10:07 +03:00
fcbe5a3fde
Add theme item descriptions to the online documentation
2021-08-06 18:20:51 +03: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
1aba997d75
doc: Sync classref with 3.3 version bump
2021-03-23 13:40:34 +01:00
b0a6439df9
doc/FileDialog: warn about access limitations in sandboxed apps
...
Co-authored-by: Rémi Verschelde <rverschelde@gmail.com>
(cherry picked from commit 1ddb0e56ac
2020-09-01 21:01:32 +02:00
ff185f715a
Add note about automatic window title to FileDialog documentation.
...
(cherry picked from commit d2250a2320
2020-06-15 14:34:35 +02:00
2652a2d184
Add generic file icon and its modulation to the 'FileDialog'
...
(cherry picked from commit 637927f803
2020-06-10 15:30:52 +02:00
3739f03d98
Add LOTS of missing docs
...
(cherry picked from commit e103f21a40
2020-03-13 17:26:30 +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
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
b397bcf4a1
Run doctool after overridden properties changes
2019-09-04 15:26:08 +03:00
e1b9004b0f
Rename FileDialog's folder icon custom color to `folder_icon_modulate`
...
The custom color introduced in be8d569744
2019-08-21 18:43:01 +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
9a173e5814
doc: Fix formatting, typos and some descriptions in new docstrings
2019-06-15 00:11:41 +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
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
4a91f94c13
Add undo-redo to the TileSet editor, and other improvements
2018-12-30 10:54:03 -02:00
e4b2a20cd6
Filled missing Doc for String and FileDialog
2018-10-12 04:46:24 +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
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
ad79c70300
Update docs
...
[ci skip]
2018-01-12 00:58:22 +02:00
5c7644d167
Merge pull request #13847 from YeldhamDev/filedialog_title
...
Added "mode_overrides_title" property to FileDialog
2017-12-09 15:48:19 +01:00
7d440d04aa
doc: Sync classref with current source
2017-12-07 08:23:08 +01:00
075edbc5ed
Added "mode_overrides_title" property to FileDialog.
2017-12-03 00:04:47 -02:00
cb4c0c630f
doc: Sync classref with current source
2017-11-27 23:37:47 +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
4c716f3623
[DOCS] Fix a few typos.
2017-10-14 12:45:49 +02: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
Hugo Locurcio
kobewi
zacryol
Rémi Verschelde
Yuri Sizov
Rémi Verschelde
umarcor
dominiks
Michael Alexsander
Bojidar Marinov
Sean Heffernan
Alexander Holland
Juan Linietsky
Andreas Haas