LDT/User Area/LuaDocumentor

Overview

LuaDocumentor allow users to generate HTML documentation and API files from some code documented using Lua documentation language. The generated HTML is similar to ldoc. It means you can probably reuse an existing ldoc CSS with virtually no modifications. The other output of LuaDocumentor is API files, an API file for a module is the original file, without the code with only the Lua document language. This is use to expose API without exposing the code. This mode is largely used to create Execution Environements.

How to install it

• Download the right archive, depending of your system architecture. (this is because we deliver the metalua code as bytecode lua)
  • 32bits version (soon available)
  • 64bits version (soon available)
• To be able to launch luadocumentor from any folder, you have two choice:
  • Add the extracted folder to the PATH environment variable
  • Under linux, create an alias in your ~/.profile witch run the luadocumentor.lua file

Command line detail

luadocumentor: tool for Lua Documentation Language

• -f, --format (default doc) Define output format :
  • doc: Will produce HTML documentation from specified file(s) or directories.
  • api: Will produce API file(s) from specified file(s) or directories.
• -d, --dir (default docs) Define an output directory. If the given directory doesn't exist, it will be created.
• -h, --help Display the help.
• -s, --style (default !) The path of your own css file, if you don't want to use the default one. (usefull only for the doc format)
• [directories|files] Define the paths or the directories of inputs files. Only Lua or C files containing a @module tag will be considered.

Examples

lua luadocumentor.lua .

Create a folder called docs containing the HTML documentation of each valid lua file under the current folder.

lua luadocumentor.lua -f api -d /tmp/output file1.lua file2.lua

Create API files for file1.lua and file2.lua in the /tmp/output folder.

lua luadocumentor.lua -f doc -d /tmp/output -s my.css /tmp/directory /tmp/file.lua

Create HTML files for the file.lua and all valid lua file in the directory in the output folder. Use my.css as stylesheet.