Package function

ldoc(options) (function)

Item summary. The item description follows. Information provided by the item comment can be formatted with both MediaWiki and Markdown syntax. The comments can generally span multiple lines.

By leaving empty comment lines, a new paragraph can be made in the documentation. This can be used to give longer explanations whitespace.

Parameters:

options Configuration options. (table)

options.file Target file. (string)

options.filter Output filter. (string; optional)

options.dump Text output to console. (boolean; optional)

Returns: Compiled documentation. (string)