Script ldoc

ldoc, a Lua documentation generator.

Compatible with luadoc-style annotations, but providing easier customization options.

C/C++ support for Lua extensions is provided.

Available from LuaRocks as ‘ldoc’ and as a Zip file

Github Page


    ldoc, a documentation generator for Lua, vs 1.4.3
      -d,--dir (default doc) output directory
      -o,--output  (default 'index') output name
      -v,--verbose          verbose
      -a,--all              show local functions, etc, in docs
      -q,--quiet            suppress output
      -m,--module           module docs as text
      -s,--style (default !) directory for style sheet (ldoc.css)
      -l,--template (default !) directory for template (ldoc.ltp)
      -p,--project (default ldoc) project name
      -t,--title (default Reference) page title
      -f,--format (default plain) formatting - can be markdown, discount or plain
      -b,--package  (default .) top-level package basename (needed for module(...))
      -x,--ext (default html) output file extension
      -c,--config (default config.ld) configuration name
      -u,--unqualified     don't show package name in sidebar links
      -i,--ignore ignore any 'no doc comment or no module' warnings
      -X,--not_luadoc break LuaDoc compatibility. Descriptions may continue after tags.
      -D,--define (default none) set a flag to be used in config.ld
      -C,--colon use colon style
      -B,--boilerplate ignore first comment in source files
      -M,--merge allow module merging
      -S,--simple no return or params, no summary
      -O,--one one-column output layout
      --dump                debug output dump
      --filter (default none) filter output as Lua data (e.g pl.pretty.dump)
      --tags (default none) show all references to given tags, comma-separated
      <file> (string) source file or directory containing source
      `ldoc .` reads options from an `config.ld` file in same directory;
      `ldoc -c path/to/myconfig.ld <file>` reads options from `path/to/myconfig.ld`
      and processes <file> if 'file' was not defined in the ld file.


  • Copyright: 2011
  • License: MIT/X11
  • Author: Steve Donovan

generated by LDoc 1.4.3 Last updated 2014-11-01 18:26:03