Nixyri/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-11-21 19:42:43 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merge pull request #92916 from Naros/expose-update-docs-from-script

Browse Source 
Expose `update_docs_from_script` method
This commit is contained in:
Rémi Verschelde 2024-09-12 09:17:35 +02:00
commit f5bf9b60bd
No known key found for this signature in database
GPG Key ID: C3336907360768E1
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

@ -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">

1
editor/plugins/script_editor_plugin.cpp
View File

@ -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")));