summaryrefslogtreecommitdiffstats
path: root/doc/classes/ScriptEditor.xml
diff options
context:
space:
mode:
authorChris Cranford <chris@hibernate.org>2024-06-08 16:45:49 -0400
committerChris Cranford <chris@hibernate.org>2024-06-08 16:45:49 -0400
commitbeef0f687c053624f057f79a14878926b77e7e8f (patch)
tree69ee962e4c03febcdb1ee77da66f571b3bea6582 /doc/classes/ScriptEditor.xml
parent5833f597865c773fae3ee09fc4e31d4a243f812d (diff)
downloadredot-engine-beef0f687c053624f057f79a14878926b77e7e8f.tar.gz
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 43ee4dda60..c205b2b8f3 100644
--- a/doc/classes/ScriptEditor.xml
+++ b/doc/classes/ScriptEditor.xml
@@ -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">