How to document pure C NativeScript/GDNative?

SonicGull

Hi everybody !

I really want to document the native C module I'm developing right now, just like the rest of Godot's main API is documented.

I've noticed in godot_headers functions that are supposed achieve that, in particular: - godot_nativescript_set_method_argument_information - godot_nativescript_set_method_documentation

However they are not accessible from godot_gdnative_ext_nativescript_api_struct which seems to be the only one exposed to the C API. Or at least, it's the only one explained in the little documentation/tutorials for godot native C libs so far. These functions would perfectly fit my desire to integrate in Godot a lib that is made to be used by others.

I deliberately avoid C++ API because it's much heavier and I don't like the idea of having a 50MB library just because I have to bundle all the godot-cpp static libraries (if you have a solution for this by the way I'm interested :))

So: What is the solution right now to document the methods I register through C API? Is it possible and how?

Thank you! <3

(NB: I'm posting this as a godot_headers issue as well and will keep both sides updated)

SonicGull

Got an answer from @karroffel on Github, pointing me to how to reach those methods. However, they are not ready to use yet, which I couldn't resist to check (and confirm), so they're no use yet.

Can't wait to see further advancements on native API and thank you so much for your work @karroffel !

Cheers

Calinou

I deliberately avoid C++ API because it's much heavier and I don't like the idea of having a 50MB library just because I have to bundle all the godot-cpp static libraries (if you have a solution for this by the way I'm interested :))

Is it still 50 MB if you compile the library in release mode and strip debugging symbols? If so, that sounds surprising to me.

SonicGull

@Calinou said:

I deliberately avoid C++ API because it's much heavier and I don't like the idea of having a 50MB library just because I have to bundle all the godot-cpp static libraries (if you have a solution for this by the way I'm interested :))

Is it still 50 MB if you compile the library in release mode and strip debugging symbols? If so, that sounds surprising to me.

So I remade the experiment: the hello world C++ SimpleLibrary is 39MB in release mode. However you're right, the godot-cpp release build surprisingly generates a static lib with debugging symbols. By manually removing the option, the hello world lib goes down to 3.2MB.

This size is much more reasonable but still looks huge to me based on the very partial use of the lib's content. I believe we can find a way to interface with Godot's API more lightly :) so I'm going to open an issue on godot-cpp to discuss this.

Thank you for your insight @Calinou !