GDExtensionSummator

GDExtensionSummator copied to clipboard

I am wondering how I would generate in engine docs tor custom nodes coming from a GDExtension? It would be phenomenal if this template extension could show how to do it.

@paddy-exe looks like stuff is happening: https://github.com/godotengine/godot/pull/67217

we might be able to do it now? Could you have a look?

@bitbrain I had another look at it and you can already have custom docs in the editor that get's automatically generated with the Extension (whether it's a Node or a ReferenceObject): There only seems to be a bug with the Argument names (but that could be on my side as well)

in the editor that get's automatically generated with the Extension

@paddy-exe I remember someone saying that the automatic generation only works for debug builds (since the debug info is part of the extension so it can infer it). I'd expect us to require defining XML files like we do for Godot itself: https://github.com/godotengine/godot/tree/master/doc but I haven't seen any documentation about it how this would work with a GDExtension.

@bitbrain Just to be on the same page: Do you mean by debug build the editor, the extension or both? Because compiling the extension for a release build still creates the docs

Because compiling the extension for a release build still creates the docs

Interesting. How does it generate things like descriptions for signals methods /arguments without us having any .xml files specified?

As far as I know this isn't even possible yet (at least considering the blog post announcement)

Help pages are automatically made available for your classes, detailing their properties, methods, signals, etc.: We're still working on the ability to also add descriptions to each.

https://github.com/godotengine/godot/pull/67298 looks promising

@bitbrain yes, the issue regarding _unamed_arg has been fixed. I'm not as familiar with the C++ extension interface and usage but if you know how to set the name of an argument it should be respected within the editor docs.

https://github.com/godotengine/godot/pull/67298 looks promising

Good to know! I will have a look when the next beta launches👍🏻

@bitbrain @Splizard : https://github.com/paddy-exe/GDExtensionSummator/pull/17 I merged some a PR that should address at least a bit of an enhancement for the class docs:

My latest PR introduces the ability to load documentation for GDExtension classes: https://github.com/paddy-exe/GDExtensionSummator/pull/66