Codebase list lua-ldoc / fe15020
doc fixes: manual_url is a function; the reference should be to List.moon not list.moon Steve Donovan 8 years ago
1 changed file(s) with 5 addition(s) and 5 deletion(s). Raw diff Collapse all Expand all
+5
-5
doc/doc.md less more
721721
722722 1.4 introduces basic support for [Moonscript](http://moonscript.org). Moonscript module
723723 conventions are just the same as Lua, except for an explicit class construct.
724 @{list.moon} shows how **@classmod** can declare modules that export one class, with metamethods
724 @{List.moon} shows how **@classmod** can declare modules that export one class, with metamethods
725725 and methods put implicitly into a separate section.
726726
727727 ## Basic Usage
12461246 when using Markdown. When explicit will expand non-references in backticks into `<code>` elements
12471247 - `plain` set to true if `format` is set but you don't want code comments processed
12481248 - `wrap` set to true if you want to allow long names to wrap in the summaries
1249 - `manual_url` point to an alternative or local location for the Lua manual, e.g.
1250 'file:///D:/dev/lua/projects/lua-5.1.4/doc/manual.html'
1249 - `manual_url(url)` point to an alternative or local location for the Lua manual, e.g.
1250 'manual_url file:///D:/dev/lua/projects/lua-5.1.4/doc/manual.html'. Remember it is a function!
12511251 - `no_summary` suppress the Contents summary
12521252 - `custom_tags` define some new tags, which will be presented after the function description.
12531253 The format is `{<name>,[title=<name>,}{hidden=false,}{format=nil}}`. For instance
12541254 `custom_tags={'remark',title='Remarks'}` will add a little `Remarks` section to the docs for any function
12551255 containing this tag. `format` can be a function - if not present the default formatter will be used,
12561256 e.g. Markdown
1257 - `custom_see_handler` function that filters see-references
1258 - `custom_display_name_handler` function that formats an item's name. The arguments are the item
1257 - `custom_see_handler(pat,handler)` function that filters see-references
1258 - `custom_display_name_handler(item, default_handler)` function that formats an item's name. The arguments are the item
12591259 and the default function used to format the name. For example, to show an icon or label beside any
12601260 function tagged with a certain tag:
12611261