summaryrefslogtreecommitdiffstats
path: root/doc/classes/ScriptEditor.xml
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2024-09-12 09:17:35 +0200
committerRémi Verschelde <rverschelde@gmail.com>2024-09-12 09:17:35 +0200
commitf5bf9b60bd0ac876c35e0f4ace171b75ad68e889 (patch)
tree2664b65fb19d86cba87850138baa8d241f61f60b /doc/classes/ScriptEditor.xml
parent2c136e6170a40f58f2dfb89d32eadfca7156ef37 (diff)
parentbeef0f687c053624f057f79a14878926b77e7e8f (diff)
downloadredot-engine-f5bf9b60bd0ac876c35e0f4ace171b75ad68e889.tar.gz
Merge pull request #92916 from Naros/expose-update-docs-from-script
Expose `update_docs_from_script` method
Diffstat (limited to 'doc/classes/ScriptEditor.xml')
-rw-r--r--doc/classes/ScriptEditor.xml8
1 files changed, 8 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">