Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "LDT/User Area/LuaDocumentor"
< LDT
(→Overview) |
(→How to install it) |
||
Line 6: | Line 6: | ||
== How to install it == | == 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 == | == Command line detail == |
Revision as of 07:31, 14 September 2012
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.lua [OPTIONS] (DIRECTORIES|FILES)...
- -f, --format: Define output format:
- doc: Will produce HTML documentation from specified file(s) or directories (default value).
- sdk: Will produce API file(s) from specified file(s) or directories.
- -d, --dir: Define an output directory, by default the output directory is "docs". If the given directory doesn't exist, it will be created.
- -h, --help: Display the help.
- -s, --style: Define a css to put with HTML files (usefull only for the doc format).
- DIRECTORIES: One or several directories to look for input files. Input files considered are lua or c files containing a @module tag.
- FILES: One or several input files. Input files considered are lua or c files containing a @module tag.
Examples
luadocumentor.lua .
luadocumentor.lua -f sdk -d /tmp/output file1.lua file2.lua
luadocumentor.lua -f doc -d /tmp/output -s my.css /tmp/directory /tmp/file.lua