[DRAFT] Generate inline documentation if it's available in the extension_api.json
#1311
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #604
This uses functionality from PR godotengine/godot#82331, which optionally adds documentation to the
extension_api.json
, to generate Doxygen-style inline documentation if it's available.This is marked as a DRAFT because it's incomplete! There's more places to inject the documentation, and there's more bbcode to parse.
This also updates the included
extension_api.json
to have the documentation. I could see an argument for not including this, since it increases the size of the file by 65%, and then leaving it up to users to include the documentation if they want it. However, I suspect that quite a few folks are going to want it?