Notice: this Wiki will be going read only early in 2024 and edits will no longer be 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
(→Command line detail) |
(→Overview) |
||
| (22 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
== Overview == | == Overview == | ||
| − | LuaDocumentor allow users to generate HTML documentation and API files from some code documented using [[ | + | LuaDocumentor allow users to generate HTML documentation and API files from some code documented using [[LDT/User_Area/Documentation_Language|Lua documentation language]]. |
The generated HTML is similar to [http://github.com/stevedonovan/LDoc ldoc]. It means you can probably reuse an existing ldoc CSS with virtually no modifications. | The generated HTML is similar to [http://github.com/stevedonovan/LDoc 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 [[ | + | 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 [[LDT/User_Area/Execution_Environment_file_format|create Execution Environements]]. |
| − | + | LuaDocumentor is based on popular lua libraries : lfs, metalua, lapp and template from penlight. | |
| − | + | Sources are available on GitHub: [https://github.com/LuaDevelopmentTools/luadocumentor https://github.com/LuaDevelopmentTools/luadocumentor]. | |
| − | + | ||
| − | + | == How to install it == | |
| − | + | ||
| − | + | <source lang="bash"> | |
| − | + | $ luarocks install --local luadocumentor | |
| + | </source> | ||
== Command line detail == | == Command line detail == | ||
| − | '''luadocumentor: tool for Lua Documentation Language''' | + | '''luadocumentor v0.1.4: tool for Lua Documentation Language''' |
| − | * -f, --format (default doc) Define output format : | + | * -f, --format (default doc) Define output format : |
** doc: Will produce HTML documentation from specified file(s) or directories. | ** doc: Will produce HTML documentation from specified file(s) or directories. | ||
** api: Will produce API file(s) 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. | + | * -d, --dir (default docs) Define an output directory. If the given directory doesn't exist, it will be created. |
| − | * -h, --help Display the help. | + | * -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) | + | * -n, --noheuristic Do not use code analysis, use only comments to generate documentation. |
| − | * [directories|files] Define the paths or the directories of inputs files. Only Lua or C files containing a @module tag will be considered. | + | * -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 == | == Examples == | ||
| − | < | + | <source lang="bash">$ luadocumentor .</source> |
| − | <center>Create a folder called ''docs'' containing the HTML documentation of each valid lua file under the current folder.</center> | + | <center><small>Create a folder called ''docs'' containing the HTML documentation of each valid lua file under the current folder.</small></center> |
| − | < | + | <source lang="bash">$ luadocumentor -f api -d /tmp/output file1.lua file2.lua</source> |
| − | <center>Create API files for file1.lua and file2.lua in the /tmp/output folder.</center> | + | <center><small>Create API files for file1.lua and file2.lua in the /tmp/output folder.</small></center> |
| − | < | + | <source lang="bash">$ luadocumentor -f doc -d /tmp/output -s my.css /tmp/directory /tmp/file.lua</source> |
| − | <center>Create HTML files for the file.lua and all valid lua file in the directory in the output folder | + | <center><small>Create HTML files for the file.lua and all valid lua file in the directory in the output folder. Use my.css as stylesheet.</small></center> |
Latest revision as of 11:56, 16 July 2014
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.
LuaDocumentor is based on popular lua libraries : lfs, metalua, lapp and template from penlight.
Sources are available on GitHub: https://github.com/LuaDevelopmentTools/luadocumentor.
How to install it
$ luarocks install --local luadocumentor
Command line detail
luadocumentor v0.1.4: 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.
- -n, --noheuristic Do not use code analysis, use only comments to generate documentation.
- -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
$ luadocumentor .
$ luadocumentor -f api -d /tmp/output file1.lua file2.lua
$ luadocumentor -f doc -d /tmp/output -s my.css /tmp/directory /tmp/file.lua