Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Custom signal descriptions are not displayed in Node > Signals tab #80397

Closed
jtwine opened this issue Aug 8, 2023 · 3 comments · Fixed by #80411
Closed

Custom signal descriptions are not displayed in Node > Signals tab #80397

jtwine opened this issue Aug 8, 2023 · 3 comments · Fixed by #80411

Comments

@jtwine
Copy link

jtwine commented Aug 8, 2023

Godot version

v4.1.1.stable.official [bd6af8e]

System information

v4.1.1.stable.official [bd6af8e]

Issue description

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):
GodotDocumentationWorking

Non-working example (signal)
GodotDocumentationNotWorking

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

  1. In Godot, create a new Node of type Node
  2. Attach a new script to this Node, accepting all current defaults
  3. In the script editor create a signal called Foo and right above it, create a ## comment for it
  4. Also create an @exported integer variable called Bar and also create a ## comment for it
  5. Unselect and reselect the Node in the Scene tab to refresh the Inspector and Node tabs
  6. Hover over the variable in the Inspector tab and see that the added description is shown correctly
  7. 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

@dalexeev 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
@akien-mga akien-mga added this to the 4.2 milestone Aug 17, 2023
@surajsharma
Copy link

duplicate of #8980 cannot believe this is marked as fixed

@DoubleCouponDay
Copy link

DoubleCouponDay commented May 16, 2024

I am still getting this issue in 3.6.4 but upgrading to 3.6.5 seems to have fixed it.

@KoBeWi
Copy link
Member

KoBeWi commented May 23, 2024

Can't reproduce in 4.3

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

6 participants