[Date Prev][Date Next][Thread Prev][Thread Next]
[Date Index]
[Thread Index]
- Subject: [ANN] LDoc 1.1 beta
- From: steve donovan <steve.j.donovan@...>
- Date: Wed, 21 Dec 2011 15:20:58 +0200
Hi all,
This is a beta version of the new LDoc [1], which is a (mostly) LuaDoc
compatible documentation tool.
By compatible, I mean that if it cannot handle an existing LuaDoc
project then it is at fault, unless it's one of LuaDoc's 'accidental'
features, like putting module(...) in a comment block to force a new
module.
You can optionally use Markdown (both markdown.lua and lua-discount
are known to work) and you can link to examples and a readme; any
example code will be prettified.
This article gives some of the background [2] (plus typical
blogosphere editorializing)
The most comprehensive example of its capabilities is the Winapi
documentation [3]
Installation is pretty straightforward (does need Penlight).
'sudo luarocks install ldoc' does what you expect, except that the
executable script ends up being called 'ldoc.lua'.
steve d.
[1] http://stevedonovan.github.com/ldoc/
[2] http://steved-imaginaryreal.blogspot.com/2011/12/documenting-lua.html
[3] http://stevedonovan.github.com/winapi/api.html