Directory tex-archive/web/lua2dox
########## lua2dox_lua 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. Files: INSTALL -- help with installation lua2dox-refm.pdf -- more extensive documentation Simon Dales 18/5/2012 ##
Directories
| Name | Notes |
|---|---|
docs |
|
|
examples |
Files
| Name | Size | Date | Notes |
|---|---|---|---|
ChangeLog |
263 | 2013-02-07 10:58:25 | |
|
Doxyfile |
77374 | 2013-01-28 07:39:27 | |
README |
324 | 2013-01-28 05:53:59 | |
|
install.bat |
688 | 2013-02-07 11:02:12 | |
install.sh |
2221 | 2013-01-28 05:59:08 | |
|
lua.def |
2018 | 2013-01-28 05:54:54 | |
lua2dox-refm.pdf |
401749 | 2013-02-07 11:07:26 | |
lua2dox-refm.tex |
13960 | 2013-02-07 10:57:57 | |
|
lua2dox.lua |
17723 | 2013-01-29 05:22:17 | |
|
lua2dox_filter |
2477 | 2012-11-27 12:17:27 | |
|
lua2dox_filter.bat |
967 | 2013-02-07 11:01:53 |
Download the complete
contents of this directory 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 TeX2DoX
tool (in development), which will process joint (La)TeX/lua
documents.
| Documentation |
Package documentation Readme |
| Version | 0.2 |
| License | The LaTeX Project Public License 1.3 |
| Maintainer | Simon Dales |
| Contained in | TeXLive as lua2dox |
| Topics |
literate programming |