Module luadoc.doclet.formatter
Doclet to format source code according to LuaDoc standard tags. This doclet (re)write .lua files adding missing standard tags. Texts are formatted to 80 columns and function parameters are added based on code analysis.
Functions
| out_file (filename) | Assembly the output filename for an input file. |
| start (doc) | Generate a new lua file for each input lua file. |
Functions
- out_file (filename)
-
Assembly the output filename for an input file. TODO: change the name of this function
Parameters
- filename:
- start (doc)
-
Generate a new lua file for each input lua file. Is the user does not specify a different output directory input files will be rewritten.
Parameters
- doc: documentation table