-
-
Notifications
You must be signed in to change notification settings - Fork 21.4k
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
GDScript(2.0) Documentation generation system #41095
GDScript(2.0) Documentation generation system #41095
Conversation
69133d9
to
4e6a799
Compare
Good job. If it's not too difficult, would be nice highlight the comment, like happens with syntax |
@AndreaCatania IMO, making the comments/documentations less visible from the source is easy to read the code, |
Usually the documenting code is marked with a different colour. Probably that yellow is wrong and too strong for its purpose. |
Perhaps a dark purple or dark green color will work. They are not used. |
4e6a799
to
580e92a
Compare
580e92a
to
9f52e39
Compare
9f52e39
to
67a4d56
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall looks great, just a few things that needs to change.
67a4d56
to
94a1906
Compare
94a1906
to
7f8c97b
Compare
@vnen completed! |
044b618
to
8e55187
Compare
8e55187
to
e47b7e5
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks really good. Just a small thing that you missed.
09dffea
to
42bfa16
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Great work!
Thanks hugely for this amazing feature, and for following up on belated reviews after GSoC :) |
Is there a way to show these tooltips in C# ? Like an attribute or XML doc or similar? |
We can probably use the generated XML doc for this, but this PR is about GDScript only. |
Will this feature ever be available in 3.x? |
@ithinkandicode That's unlikely, as this feature is built on top of the changes in master which are not compatible. Nothing is impossible, but that would require dedicated 3.x GDScript maintainers, and there is currently nobody interested in doing that work. |
I am noticing the tooltips don't update until restarting in 4 beta 11. Is this intended behaviour or am I missing an option to tell them to regenerate? |
That's a known issue / expected behavior for any change that impacts an already open inspector for the node you're editing. If you click another node and then back to this one, it should refresh. |
@akien-mga Thanks for the reply, that was helpful. Have a good one! |
The tooltips don't seem to generate if the variable is within an export category |
Yeah can confirm this happening for me as well. |
This is already properly reported: #64432 |
Not sure why this is receiving comments lately so I locked to avoid cluttering the discussion. If you have a problem with the feature then open an issue about it since comments in merged pull requests tend to be forgotten. |
Suppression of my initial pr(#39359). Refactored with GDScript 2.0
Bugsquad edit: This closes godotengine/godot-proposals#993.