Page MenuHomePhabricator

Investigate auto generating LUA docs with doxygen
Open, Needs TriagePublic

Description

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.

Event Timeline

Addshore created this task.Dec 27 2019, 8:47 AM
Restricted Application added a subscriber: Aklapper. · View Herald TranscriptDec 27 2019, 8:47 AM
Addshore moved this task from incoming to needs discussion or investigation on the Wikidata board.
Addshore added subscribers: hoo, Ladsgroup, hashar.
hashar added a comment.Aug 7 2020, 2:44 PM

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: