CTAN Comprehensive TeX Archive Network

CTAN Update: lua2dox

Date: February 8, 2013 11:59:01 AM CET
Simon Dales submitted an update to the lua2dox package. Summary description: autodoc of lua code License type: gpl Announcement text:
* Improved efficiency, but now requires doxygen >= 1.8.1 * Some bug fixes.
This package is located at http://mirror.ctan.org/support/lua2dox . More information is at http://www.ctan.org/pkg/lua2dox (if the package is new it may take a day for that information to appear). We are supported by the TeX Users Group http://www.tug.org . Please join a users group; see http://www.tug.org/usergroups.html .
Thanks for the upload. For the CTAN Team Rainer Schöpf

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.

MaintainerSimon Dales



Guest Book Sitemap Contact Contact Author