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

Documentation parse error #1

Closed
Red3Tango opened this issue Apr 11, 2024 · 3 comments
Closed

Documentation parse error #1

Red3Tango opened this issue Apr 11, 2024 · 3 comments

Comments

@Red3Tango
Copy link

Having any comments before the initial Documentation Comment ## for Brief/Description will not parse. So the Copyright notice at the top of the script files prevent documentation for showing in help search F1 or in Inspector Tooltips.

@ninstar
Copy link
Owner

ninstar commented Apr 11, 2024

Likely related to this issue which is still open: godotengine/godot#72406

@Red3Tango
Copy link
Author

Tested:
Removed the license blurb in state_machine.gd (outside of Godot while it was closed). The Docs show up in F1.
Opened state_node.gd (in Godot) made a change and saved. The Docs show up in F1
Reload editor and Docs for StateMachine are not there.

So sadly it does look like this is a bug with Godot. Either way I really like the approach you took with this plugin, simple yet well structured. Guess the workaround for now is to open the scripts and force a save smh.

@ninstar
Copy link
Owner

ninstar commented Apr 11, 2024

The issue should be fixed for now, I moved the add-on license to a separate file until they fix the documentation parser.

@ninstar ninstar closed this as completed Apr 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants