summaryrefslogtreecommitdiff
path: root/Data/Libraries/LDoc/tests/styles/opt.md
diff options
context:
space:
mode:
Diffstat (limited to 'Data/Libraries/LDoc/tests/styles/opt.md')
-rw-r--r--Data/Libraries/LDoc/tests/styles/opt.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/Data/Libraries/LDoc/tests/styles/opt.md b/Data/Libraries/LDoc/tests/styles/opt.md
new file mode 100644
index 0000000..256f6b2
--- /dev/null
+++ b/Data/Libraries/LDoc/tests/styles/opt.md
@@ -0,0 +1,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"`.