According to http://www.doxygen.nl/helpers.html https://github.com/alecchen/doxygen-lua or https://www.ctan.org/pkg/lua2dox can be used for LUA.
Having such a helper included in our doxygen could help us stop manually maintaining a docs page for our LUA code.
| Status | Subtype | Assigned | Task | ||
|---|---|---|---|---|---|
| Resolved | Lydia_Pintscher | T146637 Wikidata 2016 Q4 goals | |||
| Open | None | T241215 Improve Wikibase lower and mid level documentation | |||
| Open | None | T146665 Review and improve Lua documentation | |||
| Resolved | Addshore | T241478 Investigate auto generating LUA docs with doxygen |
It seems those plugins might not be that well maintained.
There are some tools listed on the LUA users wiki at http://lua-users.org/wiki/DocumentingLuaCode , but at a quick glance none of those tools have been updated any recently.
I looked at how lua generates its reference manual, they use a custom script "our format" inspired by LaTeX to generate HTML/Latex/Docbook. http://lua-users.org/lists/lua-l/2017-12/msg00159.html
At the risk of hijacking this task which is about Doxygen, I am a huge phan of Sphinx which happens to have a plugin to support lua, maybe that can be used instead of Doxygen https://pypi.org/project/sphinx-lua/. Might be worth investigating. It supports two syntax:
Thanks for the links
I think for now I'm just going to close this as resolved as some research has happened.
We probably won't be moving away from doxygen in the very short term.