search

dialogic-godot / documentation

📖 The documentation for the Dialogic Godot plugin.
http://docs.dialogic.pro
17 stars 12 forks source link

Add Class Reference #10

Closed CakeVR closed 6 months ago

CakeVR commented 10 months ago

Adding a class reference, like Godot Docs have, to this documentation would be very useful. It will help to always scroll through the API for each released version of Dialogic. Users can find all methods, properties, signals, and learn from the documented code.

For reference: https://docs.godotengine.org/en/4.0/classes/index.html

DanielOaks commented 10 months ago

The CLI page describes the --doctool, --no-docbase, and --gdscript-docs flags which could potentially be used to export data from the gdscript.

I think that may export XML so might need to toss it through a conversion script, but if we can autogenerate the class refs from the code comments that'd be nice.

CakeVR commented 10 months ago

Thank you, I tried finding more information on this for a long time, I was expecting it to be somewhere near the GDScript documentation, haha.

I think having a pipeline on Dialogic's main repository would be very nice too! I will open an issue for that.

CakeVR commented 6 months ago

The class reference has been added with #46.

The next step is the evaluation of #39.