lua-users home
lua-l archive

[Date Prev][Date Next][Thread Prev][Thread Next] [Date Index] [Thread Index]


On Thu, Sep 12, 2013 at 7:05 AM, Jayanth Acharya <jayachar88@gmail.com> wrote:
> Is there a doxygen like tool to generate API documentation of libraries ?

https://github.com/stevedonovan/ldoc

does that job, but the source needs doc comments (in LuaDoc style,
which is similar to JavaDoc).

> Also, once luarocks installs a library / module, is there a way to locate
> the source, to create API documentation ? I found that many (most?)
> libraries are shared-objects, so, is it that API documentation for such
> libraries cannot be generated ?

If a library does not come with explicit documentation (in 'doc' dir)
then there's no way to extract it afterwards. Bother the maintainer in
that case ;)