LDoc2tl/tests/usage/config.ld

project = 'usage'
file = 'usage.lua'
examples='usage.lua'
-- can specify the Markdown processor (falls back to markdown.lua)
format='markdown'
-- if you don't use markdown you may wish for backticks to be
-- expanded if they enclose a reference.
backtick_references = true
-- and the prettifier - this will use lxsh _if_ available
pretty='lxsh'
-- suppress @params and the summary at the top
no_return_or_parms=true
no_summary=true
examples of syntax highlighting in function @usage blocks; 'static' member functions 2013-03-05 16:57:55 +01:00			`project = 'usage'`
			`file = 'usage.lua'`
@type summary no longer dropped (#49); @type can be used with @usage (#52); CSS tweaks for prettification; nasty '<pre/>' typo squashed 2013-03-07 12:09:48 +01:00			`examples='usage.lua'`
tables inside 'classes' are implicitly 'static'; respect blank lines even if not using markdown; fall back to bundled markdown.lua if not found elsewhere 2013-03-08 12:40:59 +01:00			`-- can specify the Markdown processor (falls back to markdown.lua)`
examples of syntax highlighting in function @usage blocks; 'static' member functions 2013-03-05 16:57:55 +01:00			`format='markdown'`
tables inside 'classes' are implicitly 'static'; respect blank lines even if not using markdown; fall back to bundled markdown.lua if not found elsewhere 2013-03-08 12:40:59 +01:00			`-- if you don't use markdown you may wish for backticks to be`
			`-- expanded if they enclose a reference.`
			`backtick_references = true`
			`-- and the prettifier - this will use lxsh _if_ available`
@type summary no longer dropped (#49); @type can be used with @usage (#52); CSS tweaks for prettification; nasty '<pre/>' typo squashed 2013-03-07 12:09:48 +01:00			`pretty='lxsh'`
			`-- suppress @params and the summary at the top`
examples of syntax highlighting in function @usage blocks; 'static' member functions 2013-03-05 16:57:55 +01:00			`no_return_or_parms=true`
			`no_summary=true`