[DRAFT] Generate inline documentation if it's available in the extension_api.json#1311
[DRAFT] Generate inline documentation if it's available in the extension_api.json#1311dsnopek wants to merge 1 commit intogodotengine:masterfrom
extension_api.json#1311Conversation
|
That's cool! With this PR, it will finally be possible not to run Godot to find out details about the class and methods being used. Even 10MB of |
|
I most definitely like the idea of this being part of the |
|
What's the priority on this PR? |
It's not a very high priority for me, personally. So, if someone else is super motivated to finish this, feel free to make a new PR to supersede this one! Otherwise, I will get back to it eventually. :-) |
|
I can certainly take a look, but it'll likely be closer to the weekend before I can @GoldAndPurple |
extension_api.jsonextension_api.json
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.jsonto 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?