diff options
| author | Rémi Verschelde <rverschelde@gmail.com> | 2024-09-12 09:17:35 +0200 |
|---|---|---|
| committer | Rémi Verschelde <rverschelde@gmail.com> | 2024-09-12 09:17:35 +0200 |
| commit | f5bf9b60bd0ac876c35e0f4ace171b75ad68e889 (patch) | |
| tree | 2664b65fb19d86cba87850138baa8d241f61f60b | |
| parent | 2c136e6170a40f58f2dfb89d32eadfca7156ef37 (diff) | |
| parent | beef0f687c053624f057f79a14878926b77e7e8f (diff) | |
| download | redot-engine-f5bf9b60bd0ac876c35e0f4ace171b75ad68e889.tar.gz | |
Merge pull request #92916 from Naros/expose-update-docs-from-script
Expose `update_docs_from_script` method
| -rw-r--r-- | doc/classes/ScriptEditor.xml | 8 | ||||
| -rw-r--r-- | editor/plugins/script_editor_plugin.cpp | 1 |
2 files changed, 9 insertions, 0 deletions
diff --git a/doc/classes/ScriptEditor.xml b/doc/classes/ScriptEditor.xml index 5cf077c266..67a2af2932 100644 --- a/doc/classes/ScriptEditor.xml +++ b/doc/classes/ScriptEditor.xml @@ -99,6 +99,14 @@ [b]Note:[/b] The [EditorSyntaxHighlighter] will still be applied to scripts that are already opened. </description> </method> + <method name="update_docs_from_script"> + <return type="void" /> + <param index="0" name="script" type="Script" /> + <description> + Updates the documentation for the given [param script] if the script's documentation is currently open. + [b]Note:[/b] This should be called whenever the script is changed to keep the open documentation state up to date. + </description> + </method> </methods> <signals> <signal name="editor_script_changed"> diff --git a/editor/plugins/script_editor_plugin.cpp b/editor/plugins/script_editor_plugin.cpp index 4996964976..253005c5ce 100644 --- a/editor/plugins/script_editor_plugin.cpp +++ b/editor/plugins/script_editor_plugin.cpp @@ -4058,6 +4058,7 @@ void ScriptEditor::_bind_methods() { ClassDB::bind_method(D_METHOD("open_script_create_dialog", "base_name", "base_path"), &ScriptEditor::open_script_create_dialog); ClassDB::bind_method(D_METHOD("goto_help", "topic"), &ScriptEditor::goto_help); + ClassDB::bind_method(D_METHOD("update_docs_from_script", "script"), &ScriptEditor::update_docs_from_script); ADD_SIGNAL(MethodInfo("editor_script_changed", PropertyInfo(Variant::OBJECT, "script", PROPERTY_HINT_RESOURCE_TYPE, "Script"))); ADD_SIGNAL(MethodInfo("script_close", PropertyInfo(Variant::OBJECT, "script", PROPERTY_HINT_RESOURCE_TYPE, "Script"))); |