search

adriengivry / Overload

3D game engine with lua scripting
https://overloadengine.org/
MIT License
1.71k stars 217 forks source link

Lua documentation generation tool #105

Open adriengivry opened 4 years ago

adriengivry commented 4 years ago

Problem this feature should fix Everytime we update our Lua binding we have to update our online scripting documentation. This is a tedious task and we should automate this process.

Expected solution We should implement a tool that will help us generating the lua scripting documentation.

sierra-zero commented 2 years ago

Might be achievable through a doxygen Github Action, if c++ lua bindings were appropriately commented. Additionally, could also generate the c++ API docs.

adriengivry commented 2 years ago

I had Doxygen setup for Overload in the past, it was great to document the sources. For Lua I prototyped a C# app that generates wiki-ready pages from the lua binding files, but it's imperfect and requires manual interventions.