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
ad1aea9a46
Add multiple descriptions to several classes
...
This pull request adds several descriptions to multiple different classes.
This improves the completeness of the documentation and enhances usability by doing so.
(cherry picked from commit 27e9df7778
2021-07-06 15:30:13 +02:00
f5fe8ddacc
Added documentation to some `add_*_plugin` methods
...
Added documentation to some `add_*_plugin` methods and the corresponding `remove_*_plugin` methods.
Added an example of how to register a plugin to `add_inspector_plugin` and linked to it in the other methods.
(cherry picked from commit e849157e0721f0961610
2021-06-07 12:10:19 +02:00
c3272997cd
doc: Update classref headers with 3.4 version
2021-04-26 13:15:29 +02:00
c4f941114c
Add missing color argument in forward_canvas_draw_over_viewport example.
...
(cherry picked from commit 034c48dbed
2021-04-12 00:23:43 +02:00
015973df04
doc: Make all tutorial links point to 3.3 branch of docs
2021-03-26 10:43:43 +01:00
1aba997d75
doc: Sync classref with 3.3 version bump
2021-03-23 13:40:34 +01:00
57e57872fd
Add documentation for EditorPlugin's build method
...
(cherry picked from commit 724ed88215
2021-02-19 15:55:57 +01:00
151fa897fb
Complete documentation of EditorExportPlugin
...
(cherry picked from commit 8b231aff28
2020-12-29 16:02:03 +01:00
dc05beca80
Register methods for drawing 3D editor overlays
...
(cherry picked from commit cbfbb4538b
2020-11-11 15:30:57 +01:00
da2ac44d77
Add docs for editor viewport drawing methods
...
(cherry picked from commit 5d8b60ac3d
2020-11-11 15:30:57 +01:00
4287af5148
doc: Make docs.godotengine.org links point to 3.2 branch
2020-10-19 16:10:01 +02:00
41e385cfac
Document EditorPlugin get_plugin_icon and get_plugin_name
...
The return value's type hint is now accurate.
(cherry picked from commit 68d73ecf60
2020-03-06 23:51:25 +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
45767fe5f6
Improve documentation of EditorPlugin.add_tool_submenu_item method
2019-08-12 20:58:21 +01:00
16288cabc0
doc: More formatting fixes
2019-07-22 12:41:41 +02:00
5b20b49bf7
doc: Formatting fixes in EditorPlugin docs
2019-07-22 12:37:33 +02:00
07e289963c
doc: Sync classref with current source
2019-07-22 12:27:52 +02:00
2acc1e3079
Add description for EditorPlugin.enable/disable methods
2019-07-20 10:53:56 -03:00
c7b0eed757
Add docs for EditorInterface, EditorPlugin and EditorSceneImporter
2019-07-20 10:41:42 -03: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
71d53637b5
doc: Fix scoped hyperlinks to same-class enums/methods
...
The class name does not need to be specified when it is the current class.
2019-06-27 11:44:37 +02:00
86ed7a9884
doc: Complete and harmonize all _MAX constant descriptions
2019-06-27 11:10:53 +02:00
cfb9709c10
doc: Sync classref with current source
2019-06-01 12:34:29 +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
5fe2bf125a
Add description for EditorPlugin.update_overlays
2019-05-17 22:36:40 +09:00
ab4705a807
Merge pull request #28125 from KoBeWi/code_true_code
...
Consistently wrap booleans in [code]
2019-04-22 11:59:16 +02:00
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
b0846f60c9
Consistently wrap booleans in [code]
2019-04-17 17:13:00 +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
ac46862097
Merge pull request #24506 from JFonS/expose_gizmos
...
Expose the new gizmo plugin system to scripting
2018-12-30 15:42:30 +01:00
2e39e38c10
doc: Sync classref with current source
...
Fix various code formatting issues and argument names.
2018-12-27 11:10:18 +01:00
6b15b4f904
Expose the new gizmo plugin system to scripting
2018-12-21 23:56:39 +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
f115f00ec6
Allow plugin scene change signal to report null for empty scenes.
2018-11-03 00:11:02 +02:00
0279985a70
Merge pull request #22218 from char0xff/doc_editorpluginsinterface
...
Improve EditorPlugin.xml and EditorInterface.xml
2018-09-21 14:58:27 +02:00
83758a9004
doc: Sync classref with current source
2018-09-21 09:33:05 +02:00
a0efe25c9e
Improve EditorPlugin.xml and EditorInterface.xml
2018-09-18 16:38:19 +02:00
29f2571662
update class docs
2018-08-31 22:35:15 +02:00
5267099a87
doc: Sync classref with current source
2018-08-29 22:25:11 +02:00
4ea3e4f551
doc: Sync classref with current source
2018-08-21 00:35:46 +02:00
2a6c591957
Expose ScriptCreateDialog to EditorPlugin
2018-07-04 09:41:12 -05: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
4c5dd51eb9
Sync classref with current source
...
Also fix binding of Basis.slerp
2018-05-28 14:53:15 +02:00
3d9deda8b3
Sync classref with current source
2018-05-12 09:38:00 +02:00
72aa87758a
Update classref and docs, fix missing parameters' name
2018-04-11 10:20:22 +07:00
cb7fe2c793
doc: Sync classref with current source
2018-04-10 10:12:42 +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
eb63f7b071
[DOCS] Sync classref with current source
2018-02-25 15:14:25 +07:00
Rémi Verschelde
Nick Huelin
RoniPerson
Anders Stenberg
Yuri Sizov
kobewi
Aaron Franke
Max Hunt
Henrique Campos
Hugo Locurcio
Sean Heffernan
volzhs
JFonS
Jared
Max Hilbrunner
char0xff
Kelly Thomas
willnationsdev
robojumper
Poommetee Ketson