Codebase list lua-ldoc / cf3b293e-cc6e-4a0d-bd71-918fc57c6cc4/main tests / styles / opt.md
cf3b293e-cc6e-4a0d-bd71-918fc57c6cc4/main

Tree @cf3b293e-cc6e-4a0d-bd71-918fc57c6cc4/main (Download .tar.gz)

opt.md @cf3b293e-cc6e-4a0d-bd71-918fc57c6cc4/mainraw · history · blame

1
2
3
4
5
6
7
8
9
By default, an unbroken series of opt modifiers is converted to
'opt','optchain','optchain', so you get `(a[,b[,c])`.

If `convert_opt` is specified, then no such conversion takes place; you then 
must explicitly use `optchain`.

The `@include` tag is only meaningful for project-level items like modules,
scripts, etc. The file is inserted into the document after being formatted.
In this case, you would usually specify `format="markdown"`.