You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
In-script documentation (##) for signal members is not appearing in the Node tab as expected. Other documentation appears to work correctly in the Inspector tab.
Working example (exported variable):
Non-working example (signal)
I have tried deselecting and reselecting the associated Node, changing between the tabs on the left pane, changing active scripts and even restarting Godot - nothing makes it work. According to the GScript Documentation on Documentation Comments, this should work, right? Or is there something completely obvious that I am missing?
Steps to reproduce
In Godot, create a new Node of type Node
Attach a new script to this Node, accepting all current defaults
In the script editor create a signal called Foo and right above it, create a ## comment for it
Also create an @exported integer variable called Bar and also create a ## comment for it
Unselect and reselect the Node in the Scene tab to refresh the Inspector and Node tabs
Hover over the variable in the Inspector tab and see that the added description is shown correctly
Hover over the signal in the Node tab and see that the added description is not shown and "No description." is shown instead
This is an example of the script that could be added:
## This is signal foo!
signal Foo
## This is exported signal bar!
@export var Bar : int = 0
Minimal reproduction project
N/A
The text was updated successfully, but these errors were encountered:
dalexeev
changed the title
GScript Documentation Comments for Signals are not Displaying as Expected in the Node Tab
Custom signal descriptions are not displayed in Node > Signals tab
Aug 8, 2023
Godot version
v4.1.1.stable.official [bd6af8e]
System information
v4.1.1.stable.official [bd6af8e]
Issue description
In-script documentation (
##
) forsignal
members is not appearing in the Node tab as expected. Other documentation appears to work correctly in the Inspector tab.Working example (exported variable):
Non-working example (
signal
)I have tried deselecting and reselecting the associated Node, changing between the tabs on the left pane, changing active scripts and even restarting Godot - nothing makes it work. According to the GScript Documentation on Documentation Comments, this should work, right? Or is there something completely obvious that I am missing?
Steps to reproduce
Node
signal
calledFoo
and right above it, create a##
comment for it@export
ed integer variable calledBar
and also create a##
comment for itThis is an example of the script that could be added:
Minimal reproduction project
N/A
The text was updated successfully, but these errors were encountered: