1f72f48361
[doc] Use "param" instead of "code" to refer to parameters #3
2022-08-09 22:00:19 -04:00
c5d7115038
Rename the argument tag to param in XML documentation
2022-08-08 22:34:31 +03: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
d54f2ad7ca
Don't generate empty doc sections and reduce code duplication
2021-09-20 20:59:33 -05: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
7ff135b015
Consistently prefix bound virtual methods with _
2021-06-12 00:55:52 +02:00
b707920355
Update SyntaxHighlighter documentation
2020-10-11 17:14:37 +01:00
adb205a150
add description for ScriptEditor.open_script_create_dialog()
2020-09-19 00:03:24 +02:00
b79aa89796
doc: Sync classref with current source
2020-07-15 08:43:21 +02:00
a225265b0a
Document how some editor classes should be accessed as singletons only
...
This closes #37687 .
2020-04-22 11:39:59 +02:00
e103f21a40
Add LOTS of missing docs
2020-03-13 16:35:03 +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
5313ce232d
Merge pull request #27870 from mawenzy/pr_gotoline
...
Bind goto_line function for Script Editor
2019-04-30 10:53:23 +02:00
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
d87021de93
Bind goto_line function for Script Editor #9153
...
- added doc for ScriptEditor:goto_line
2019-04-16 17:32:10 +02:00
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
29f2571662
update class docs
2018-08-31 22:35:15 +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
8d03cafd7c
doc: Sync classref with current source
2018-01-03 13:45:03 +01:00
d03f35f1bc
Bind TextEdit.deselect and update documentation
2017-12-16 21:08:31 +01:00
bc75fae579
doc: Update header version for 3.0-beta
2017-11-24 09:16:52 +01:00
11e07d18bd
doc: Sync classref with current source
2017-11-15 21:29:34 +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
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
Andy Maloney
Yuri Sizov
Hugo Locurcio
Aaron Franke
Rémi Verschelde
kobewi
Paulb23
Leleat
clayjohn
mawenzy
Kelly Thomas
Juan Linietsky