Commit Graph

44 Commits

Author SHA1 Message Date
steve donovan 2fbe566039 Bumped version to 1.4.3; doc updates; C lexer ignores strings (which it handles badly) 2014-10-21 17:57:26 +02:00
steve donovan 31ee8f5cbc Issue #174: @include tag for including processed documentation file into output; last item now has a distinct line number, and some nasty tabs have been removed 2014-10-12 18:35:19 +02:00
steve donovan 56ac2601c0 Tweaks to opt/optchain: (optional) is emitted after optional arguments without defaults. convert_opts (counter-intuitively) disables automatic opt->optchain promotion 2014-10-12 16:45:09 +02:00
steve donovan cfdc6f8f53 new feature: prettify_files makes per-item links to source; unless this field is 'show', don't put in index 2014-10-12 16:09:09 +02:00
hanxi 609805a7a7 add update time to the page footer 2014-09-10 10:37:11 +08:00
Steve Donovan a0c780f093 allow Markdown headers in module docstring by stripping #.. 2014-06-20 15:09:38 +02:00
steve donovan 3f32313ced #158 summary line lost with @type tag 2014-05-25 13:58:25 +02:00
Steve Donovan 624ff11afd parameter names which were List methods overwriting object - factor out as map field 2014-04-23 13:19:16 +02:00
Steve Donovan 2c0d459a43 bumped version to 1.4.2 2014-01-16 09:53:29 +02:00
steve donovan d367390c68 Issue #150: 'info' section ordering is now consistent 2014-01-07 17:48:50 +02:00
Steve Donovan f60e6d4197 Pull #121 applied manually - custom tags may be hidden 2013-12-09 15:13:00 +02:00
abadc0de 89854e1537 Custom tags
Custom tags
2013-11-28 10:46:59 -05:00
Steve Donovan 8081e5b43c option to use Markdown titles instead of file names with 'use_markdown_titles' (otherwise drop the .md extension on display) 2013-11-18 10:26:40 +02:00
steve donovan 9ef1f08784 can resolve references to local class; no longer have 'Topic: ' for readme documents 2013-11-17 19:48:35 +02:00
steve donovan 955802e07b Issue #93: can define fields/properties of objects; the 'readonly' modifier is now special. See tests/styles/type.lua 2013-11-16 19:21:50 +02:00
Steve Donovan 8e3e211716 fixup selected module item 2013-08-27 14:16:21 +02:00
Steve Donovan 1d1ed6d0f0 on left-hand side all module names go through doc.module_name. This strips off package part currently 2013-08-27 13:17:11 +02:00
Steve Donovan f33a09e4d3 issue #76 auto-scroll to avoid breaking identifiers 2013-08-27 12:44:04 +02:00
steve donovan 149ded81fc composite return types experiment 2013-08-25 10:47:45 +02:00
steve donovan 9af4bae066 return groups; experimental 'error' tag 2013-08-24 13:21:41 +02:00
Steve Donovan 70eaf2be6f bumped to 1.4.0; doc updates and formatting 2013-08-23 13:50:34 +02:00
Steve Donovan 7bb95e5e7d issue #78 default parm value now in documentation 2013-08-22 10:12:04 +02:00
Steve Donovan 3c72e9e4d1 fix issue #80, backticks expand in copyright and other 'info' tags. format='backtick' (-f backtick) is like format='plain' but with implicit 'backtick_references=true'. -X is short for 'not_luadoc' 2013-08-22 09:43:26 +02:00
Steve Donovan 5699d002ef issue #77: 'See also' in template 2013-08-20 14:59:13 +02:00
Steve Donovan 52e9b6f32c new classmod tag for defining modules that just export one class (experimental) 2013-08-07 15:19:46 +02:00
steve donovan ff2e5ccaed Default output directory is now 'doc'; annotations were borked and not_luadoc check could blow up 2013-05-15 15:30:47 +02:00
steve donovan ac5c5f2c65 'plain=true' when format is set but you do not want doc comments treated specially. Backticks are now expanded in usage blocks 2013-05-09 12:52:15 +02:00
steve donovan 97af82c53d bumped to 1.3.11 2013-04-13 16:15:54 +02:00
steve donovan 619d8e1710 -O for one col layout, -S for simple (no params,ret or summary); one col switches off function list. Bumped to 1.3.8 2013-03-28 13:28:05 +02:00
steve donovan 158aa9ff14 can override utf-8 with either 'charset=<cs>' or per-module with @charset <cs> 2013-03-27 15:50:37 +02:00
steve donovan 4bc48dafc3 modules returning a single function are supported, see tests/styles/func.lua. Parameters may have subfields, see tests/styles/subparams.lua 2013-03-18 15:51:28 +02:00
steve donovan 496b534ce1 @type summary no longer dropped (#49); @type can be used with @usage (#52); CSS tweaks for prettification; nasty '<pre/>' typo squashed 2013-03-07 13:09:48 +02:00
steve donovan 7ceb7cc00b @usage code blocks are prettified 2013-03-05 16:21:54 +02:00
steve donovan 1b67b1cd6f wrap=true in config.ld will switch off nowrap in name column of function tables 2013-02-13 14:44:33 +02:00
steve donovan 1bb83924bb in implicit function style (a la Geoff) the first comment refers to the return value. In colon style, an exclamation mark allows a typename to be directly used as a 'tag'. The word 'optional' is only issued if we have either nil or a type 2012-12-31 14:52:00 +02:00
steve donovan cdebc952e4 usage section is now after returns: bumped vs to 1.3 2012-12-29 12:05:51 +02:00
steve donovan 754da6e8d8 usage strings were not HTML-escaped properly (Eric) 2012-12-13 19:18:24 +02:00
Geoff Leyland 2b304a2252 Use classes for formatting argument descriptions rather than tags 2012-10-29 13:26:07 +13:00
steve donovan 9d0d12c31a refs to Lua 5.2 docs (if we are using 5.2) and bumped up major version to 1.2 2012-03-13 10:37:07 +02:00
steve donovan dcd62ffa9d doc updates; problem with @usage with scripts; formal arguments now always take precendence; warnings cleaned up 2011-12-09 15:43:37 +02:00
steve donovan 70e1f22909 tparam/treturn aliases for type modifiers: display of types with standard template 2011-12-06 19:19:09 +02:00
steve donovan 88326dc668 update builtin luadoc; tweaks to template 2011-09-22 15:48:09 +02:00
steve donovan fbbdba7ecf documenting customizing options; problem with no_summary fixed 2011-09-21 15:50:11 +02:00
steve donovan 1dd35e86a0 great renaming: moved everything into ldoc module tree 2011-09-20 12:59:34 +02:00