Comprehensive TeX Archive Network

Direc­tory 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


Down­load the con­tents of this pack­age in one zip archive (792.1k).

lu­a2­dox – Auto-doc­u­men­ta­tion of lua code

The pack­age ex­tends the well-known C-like lan­guage autodoc tool, doxy­gen, to read and doc­u­ment lua code.

In use, you edit and test your code and pe­ri­od­i­cally run the autodoc tool to up­date the doc­u­men­ta­tion, which may be viewed via an html browser.

Autodoc tools can read the code well enough to find func­tion/... dec­la­ra­tions and doc­u­ment them. If the code also con­tains ap­pro­pri­atly for­mat­ted “magic com­ments”, the tool can use them to sup­ple­ment the doc­u­men­ta­tion.

The pack­age is a first pro­to­type of a planned 2DoX tool (in de­vel­op­ment), which will pro­cess joint /lua doc­u­ments.

Li­cense The Project Public Li­cense 1.3
Main­tainer Si­mon Dales
Con­tained inTeX Live as lu­a2­dox
Topics lit­er­ate pro­gram­ming
Guest Book Sitemap Contact Contact Author