godotengine/godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Expose update_docs_from_script method

Browse Source
This commit is contained in:
Chris Cranford 2024-06-08 16:45:49 -04:00
parent 5833f59786
commit beef0f687c
2 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
doc/classes/ScriptEditor.xml
View File

@ -94,6 +94,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">

1
editor/plugins/script_editor_plugin.cpp
View File

@ -3980,6 +3980,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")));