LuaDoc for semi Automatic Documentation

Solar2D Lua Language
#1

I would like to use luadoc to “automatically” document my project classes and libraries. The problem is that I don’t even know how to install it nor how to configure it to work with Corona Projects.

I tried to install it:

  1. Clone the respository
  2. make
sudo make /Users/ernestbofill/.luadoc/Makefile
  1. doesn’t work
make: Nothing to be done for `/Users/ernestbofill/.luadoc/Makefile'. 

I have lua installed with macports.

Anyone has used luadoc with Corona?

Some hints about setting it up?

Thanks for your help

ErnestB.

#2

Since I found the way of doing it I am going to share my solution in case somebody else is interested.

It’s pretty straight forward.

To install luadoc

You need Homebrew installed

brew install luarocks luarocks install luadoc luadoc -d your\_output\_directory your\_project\_directory

just type luadoc for help and more options.

dependencies are handled automatically.

You may also like to give a try to LDoc. I like it better than LuaDoc so far.

ErnestB.

#3

Since I found the way of doing it I am going to share my solution in case somebody else is interested.

It’s pretty straight forward.

To install luadoc

You need Homebrew installed

brew install luarocks luarocks install luadoc luadoc -d your\_output\_directory your\_project\_directory

just type luadoc for help and more options.

dependencies are handled automatically.

You may also like to give a try to LDoc. I like it better than LuaDoc so far.

ErnestB.