summaryrefslogtreecommitdiff
path: root/modules
diff options
context:
space:
mode:
authorRémi Verschelde <rverschelde@gmail.com>2023-01-19 10:09:04 +0100
committerRémi Verschelde <rverschelde@gmail.com>2023-01-19 10:09:04 +0100
commit56ac1a67cdfdccc64757197464d9bc1f2704a2f0 (patch)
tree37381578de9acf7e471636459e66b3d565d8ace0 /modules
parent9de2da1a9687bef1d83f7d1a9e36430490cc0f33 (diff)
parent807b7ed557950ef9bd17266a35f7f83b1181e130 (diff)
Merge pull request #71620 from adamscott/move-icon-to-top
Update `@icon` and `@tool` definitions to add a note
Diffstat (limited to 'modules')
-rw-r--r--modules/gdscript/doc_classes/@GDScript.xml2
1 files changed, 2 insertions, 0 deletions
diff --git a/modules/gdscript/doc_classes/@GDScript.xml b/modules/gdscript/doc_classes/@GDScript.xml
index fd748ea569..3fe741a582 100644
--- a/modules/gdscript/doc_classes/@GDScript.xml
+++ b/modules/gdscript/doc_classes/@GDScript.xml
@@ -553,6 +553,7 @@
@icon("res://path/to/class/icon.svg")
[/codeblock]
[b]Note:[/b] Only the script can have a custom icon. Inner classes are not supported.
+ [b]Note:[/b] As annotations describe their subject, the [code]@icon[/code] annotation must be placed before the class definition and inheritance.
</description>
</annotation>
<annotation name="@onready">
@@ -585,6 +586,7 @@
@tool
extends Node
[/codeblock]
+ [b]Note:[/b] As annotations describe their subject, the [code]@tool[/code] annotation must be placed before the class definition and inheritance.
</description>
</annotation>
<annotation name="@warning_ignore" qualifiers="vararg">