| 1203 | 1203 |
- `examples` a directory or file: can be a table
|
| 1204 | 1204 |
- `readme` or `topics` readme files (to be processed with Markdown)
|
| 1205 | 1205 |
- `pretty` code prettify 'lua' (default) or 'lxsh'
|
|
1206 |
- `prettify_files` prettify the source as well and make links to it; if its value is "show"
|
|
1207 |
then also index the source files.
|
| 1206 | 1208 |
- `charset` use if you want to override the UTF-8 default (also **@charset** in files)
|
| 1207 | 1209 |
- `sort` set if you want all items in alphabetical order
|
| 1208 | 1210 |
- `no_return_or_parms` don't show parameters or return values in output
|
|
1211 |
- `no_lua_ref` stop obsessively trying to create references to standard Lua libraries
|
| 1209 | 1212 |
- `backtick_references` whether references in backticks will be resolved. Happens by default
|
| 1210 | 1213 |
when using Markdown. When explicit will expand non-references in backticks into `<code>` elements
|
| 1211 | 1214 |
- `plain` set to true if `format` is set but you don't want code comments processed
|
| 1212 | |
- `wrap` ??
|
|
1215 |
- `wrap` set to true if you want to allow long names to wrap in the summaries
|
| 1213 | 1216 |
- `manual_url` point to an alternative or local location for the Lua manual, e.g.
|
| 1214 | 1217 |
'file:///D:/dev/lua/projects/lua-5.1.4/doc/manual.html'
|
| 1215 | 1218 |
- `no_summary` suppress the Contents summary
|
|
1219 |
- `custom_tags` define some new tags, which will be presented after the function description.
|
|
1220 |
The format is `{<name>,[title=<name>,}{hidden=false,}{format=nil}}`. For instance
|
|
1221 |
`custom_tags={'remark',title='Remarks'}` will add a little `Remarks` section to the docs for any function
|
|
1222 |
containing this tag. `format` can be a function - if not present the default formatter will be used,
|
|
1223 |
e.g. Markdown
|
| 1216 | 1224 |
- `custom_see_handler` function that filters see-references
|
| 1217 | 1225 |
- `custom_display_name_handler` function that formats an item's name. The arguments are the item
|
| 1218 | 1226 |
and the default function used to format the name. For example, to show an icon or label beside any
|
| 1219 | 1227 |
function tagged with a certain tag:
|
|
1228 |
|
| 1220 | 1229 |
-- define a @callback tag:
|
| 1221 | 1230 |
custom_tags = { { 'callback', hidden = true } }
|
| 1222 | 1231 |
|
|
| 1230 | 1239 |
|
| 1231 | 1240 |
- `not_luadoc` set to `true` if the docs break LuaDoc compatibility
|
| 1232 | 1241 |
- `no_space_before_args` set to `true` if you do not want a space between a function's name and its arguments.
|
| 1233 | |
- `template_escape` overrides the usual '#' used for Lua code in templates. This needs to be changed if the output format is Markdown, for instance.
|
|
1242 |
- `template_escape` overrides the usual '#' used for Lua code in templates.
|
|
1243 |
This needs to be changed if the output format is Markdown, for instance.
|
| 1234 | 1244 |
|
| 1235 | 1245 |
_Available functions are:_
|
| 1236 | 1246 |
|