godotengine
/
godot
mirror of https://github.com/godotengine/godot
1
0
Fork 0
Code

Merge pull request #71620 from adamscott/move-icon-to-top 

Update `@icon` and `@tool` definitions to add a note
This commit is contained in:
Rémi Verschelde 2023-01-19 10:09:04 +01:00
parent 9de2da1a96 807b7ed557
commit 56ac1a67cd
No known key found for this signature in database
GPG Key ID: C3336907360768E1
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
modules/gdscript/doc_classes/@GDScript.xml
View File

@ -553,6 +553,7 @@
@icon("res://path/to/class/icon.svg") @icon("res://path/to/class/icon.svg")
[/codeblock] [/codeblock]
[b]Note:[/b] Only the script can have a custom icon. Inner classes are not supported. [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> </description>
</annotation> </annotation>
<annotation name="@onready"> <annotation name="@onready">
@ -585,6 +586,7 @@
@tool @tool
extends Node extends Node
[/codeblock] [/codeblock]
[b]Note:[/b] As annotations describe their subject, the [code]@tool[/code] annotation must be placed before the class definition and inheritance.
</description> </description>
</annotation> </annotation>
<annotation name="@warning_ignore" qualifiers="vararg"> <annotation name="@warning_ignore" qualifiers="vararg">