CTAN Comprehensive TeX Archive Network

Directory web/lua2dox


This is a hack to enable doxygen to document lua.

It uses the wellknown doxygen filter mechanism to fool doxygen into reading foreign languages.

If this works for you then enjoy.

	INSTALL -- help with installation
	lua2dox-refm.pdf -- more extensive documentation

Simon Dales


Download the contents of this package in one zip archive (792.1k).

lua2dox – Auto-documentation of lua code

The package extends the well-known C-like language autodoc tool, doxygen, to read and document lua code.

In use, you edit and test your code and periodically run the autodoc tool to update the documentation, which may be viewed via an html browser.

Autodoc tools can read the code well enough to find function/... declarations and document them. If the code also contains appropriatly formatted “magic comments”, the tool can use them to supplement the documentation.

The package is a first prototype of a planned 2DoX tool (in development), which will process joint /lua documents.

LicensesThe Project Public License 1.3
MaintainerSimon Dales
Guest Book Sitemap Contact Contact Author