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
229489f7b7
Expose ScriptEditor::edit to scripting
...
Exposes a method in `EditorInterface` to open scripts on a specified
line and column. This method handles if the internal or the external
editor should be used.
(cherry picked from commit 9535831866
2021-12-09 12:05:14 +01: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
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
f72c91e0b1
Expose edit_node() for editor plugins
...
(cherry picked from commit 72014a7a2e
2021-04-12 09:24:37 +02:00
ea5b3dda93
Expose editor scale to the plugin API
...
(cherry picked from commit ea31af68ba
2021-04-06 10:18:20 +02:00
1aba997d75
doc: Sync classref with 3.3 version bump
2021-03-23 13:40:34 +01:00
98eb6e4af6
Added inspector_only option to inspect_object in EditorInterface.
...
Updated docs to reflect change to inspect_object.
(cherry picked from commit 45a1c6f278
2020-09-29 13:57:57 +02:00
2987fb3b45
Improve the EditorInterface.get_editor_viewport() description
...
This closes https://github.com/godotengine/godot-docs/issues/1109 .
(cherry picked from commit 60d40d8430
2020-07-30 16:27:11 +02:00
606d4270c6
Document several editor-related classes to 100% completion
...
(cherry picked from commit fb2e4d77eb
2020-07-24 10:31:57 +02:00
2b4773f0cf
Expose methods to play scene from plugin code
...
(cherry picked from commit 49f6dc5004
2020-07-06 19:00:56 +02:00
8cc3d4bda6
Keep the bottom panel visible when enabling the distraction-free mode
...
- Document the `EditorInterface.distraction_free_mode` property.
This closes https://github.com/godotengine/godot-proposals/issues/951 .
(cherry picked from commit e6352d1daa
2020-06-29 10:46:05 +02:00
9e01a0cd28
Add a getter and property for the editor distraction-free mode
...
(cherry picked from commit cc1859efed
2020-06-04 12:16:39 +02:00
f3cd7e3808
Document how some editor classes should be accessed as singletons only
...
This closes #37687 .
(cherry picked from commit a225265b0a
2020-04-27 10:11:53 +02:00
fdd85311c3
Sync classref with current source
2020-03-25 11:42:15 +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
4f294b958f
doc: Sync classref with current source
...
Fix a few missing bindings or unspecified argument names and default values.
2019-09-24 11:52:06 +02:00
592909db16
doc: Sync classref with current source
2019-08-13 12:35:50 +02: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
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
09e94aa087
doc: Sync classref with current source
2019-04-15 14:49:41 +02:00
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
2e39e38c10
doc: Sync classref with current source
...
Fix various code formatting issues and argument names.
2018-12-27 11:10:18 +01:00
a0efe25c9e
Improve EditorPlugin.xml and EditorInterface.xml
2018-09-18 16:38:19 +02:00
0c10d3fc16
Update EditorInterface.xml
2018-09-15 18:25:48 +02:00
e03de3ddfc
Exposed set/get_project_metadata in EditorSettings.
2018-05-16 12:44:15 -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
87be0bc110
Add interface for plugins to enable/disable other plugins
2018-01-30 20:25:20 -02: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
29e68aa40e
doc: Sync classref with current source
2018-01-07 01:37:45 +01:00
bc75fae579
doc: Update header version for 3.0-beta
2017-11-24 09:16:52 +01:00
e7701bb2de
doc: Rename "@Global Scope" to "@GlobalScope"
...
Spaces in filenames are evil.
2017-11-15 20:41:16 +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
b302084395
makerst: Fix rst-ization of members and escaping of [Class]s
...
Fixes #11517 .
2017-10-21 12:33:52 +02:00
7f2d36bf84
[DOCS] EditorInterface
2017-10-17 17:13:27 +02:00
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
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
