cschreib / lxgui

Portable, real time, modular and data-driven GUI C++ library.
https://cschreib.github.io/lxgui
MIT License
75 stars 20 forks source link

Add infrastructure for generating documentation of Lua API #53

Closed cschreib closed 3 years ago

cschreib commented 3 years ago

Currently, the Lua API of lxgui is undocumented. It follows closely the original WoW API, but:

Acceptance criteria:

Once this is done, getting the API fully documented can be a background task.

cschreib commented 3 years ago

Started this with https://github.com/lunarmodules/LDoc in branch https://github.com/cschreib/lxgui/tree/lua-doc. It seems not possible to get Doxygen to reliably include Lua documentation, so I'm going for a separate output for C++ and Lua. It's a bit of a shame, but there should be a way to link the two together.

cschreib commented 3 years ago

The Lua API documentation is now available here https://cschreib.github.io/lxgui/lua/index.html