[Date Prev][Date Next][Thread Prev][Thread Next]
- Subject: Re: API documentation for libraries
- From: steve donovan <steve.j.donovan@...>
- Date: Thu, 12 Sep 2013 10:28:10 +0200
On Thu, Sep 12, 2013 at 10:22 AM, Jayanth Acharya <firstname.lastname@example.org> wrote:
> I presume, in this case I could use ldoc on the source... or is it that ldoc
> won't generate anything useful without the LuaDoc style comments embedded in
> source ?
That's right - you can use ldoc on C, but it needs doc comments (at
least /*** .... */).
luarocks also has a 'show' command, which helps if the home page of
the project has some docs
$ luarocks show --home ldoc
or being fancy:
$ firefox $(luarocks show --home ldoc)