Commit Graph

149 Commits

Author SHA1 Message Date
steve donovan 68cd576bf4 module deduction can blow up; UTF BOM ignored 2013-04-16 10:11:05 +02:00
steve donovan 0ee96935a3 charset functionality was borked in general case 2013-04-03 12:20: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 897061ac17 squashed trailing space problem with section titles; allowing numbers in links 2013-03-28 13:06:42 +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 d176dedcfc bump version to 1.3.8 in usage; ignore empty docstrings (Dirk bug) 2013-03-26 11:53:42 +02:00
steve donovan 0706681e72 using parameters which were List method names caused chaos 2013-03-25 10:12:20 +02:00
steve donovan a7b01abd03 module at-references now working! No-contents warning fixed 2013-03-23 17:51:55 +02:00
steve donovan a8ea31b01d fixed opt bug and weird issue when section title clashes with standard section names 2013-03-21 19:52:53 +02:00
steve donovan 741cba8ff2 merging trailing [opt] as [optchain]s. Trying to solve 'self' references in modules 2013-03-20 14:41:54 +02:00
steve donovan 65723a9dc4 issue #57: [opt=default] support - see tests/styles/four.lua 2013-03-19 15:00:57 +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 717eac46e5 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 13:40:59 +02:00
steve donovan dee7cd200a fixed issue #47; flag-style tags like @local were blowing up with description collection 2013-03-07 13:49:39 +02:00
steve donovan d7ee2d806f no longer an error for @function to have modifiers (#45), although we're not yet passing it through. New @static tag for class methods 2013-03-07 13:39:41 +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 8856f09629 pretty field can be set to 'lxsh'; github-flavoured Markdown fenced code blocks; if lxsh, can also highlight c, sh and bib 2013-03-06 17:07:28 +02:00
steve donovan 95f293e67e ordinary non 'method' functions of a 'class' must be respected, and not prefixed with class: 2013-03-05 17:56:30 +02:00
steve donovan 357ee3978d don't strip multiline tag values. Allows multiline @usage blocks to work nicely 2013-03-05 17:00:33 +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 394ba636bc link fix in docs and anti-global jihad 2013-02-13 14:15:29 +02:00
steve donovan 55bbeed4f4 added module merging - see tests/merge directory (--merge flag) 2013-01-28 11:23:31 +02:00
steve donovan 10b5819667 new_type() can now specify subfield; Colon mode must be explicitly switched on with -C,--colon or in config.ld 2013-01-25 09:09:40 +02:00
steve donovan 5e87bcf400 serious .0 bug squashed! nocolon option to turn off colon-style detection. boilerplate option forces first comments to be ignored 2013-01-02 13:04:14 +02:00
steve donovan 9021b144b8 usage is now explicitly a multiline tag, so it is not considered part of the description. We are now ignoring Lua comments like so --- some text --- since they're commonly used to indicate logical sections - not for export 2012-12-31 17:02:40 +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 c49fa67644 more tests; styles meant as catalog of supported styles, submodule shows off within and submodule tag 2012-12-29 12:09:34 +02:00
steve donovan 29134ef169 tags as ordered maps; Geoff refactorings 2012-12-29 12:07:26 +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 a3aa4dc979 within tag working; allow description to appear after some tags (needed tags as ordered maps for this) 2012-12-29 12:04:39 +02:00
steve donovan b039ac1574 fix for last Geoff patch (was asleep) 2012-12-28 11:00:10 +02:00
steve donovan 0f68f97513 added support for Luamark (Geoff) 2012-12-28 10:56:43 +02:00
steve donovan 4801a6ba10 export tag gives warnings if an item has not been documented 2012-12-22 16:29:42 +02:00
steve donovan d51a8d63c9 tables may now have _any_ mix of field and param tags. Fixes hack to permit type macros in table definitions 2012-12-21 19:13:40 +02:00
steve donovan f54e13185e tag modifier code not respecting boolean types; export tag now properly makes local functions module-scope 2012-12-21 18:25:06 +02:00
steve donovan 3f70bd16f8 Ignore first non-doc comment (Geoff) 2012-12-21 18:23:18 +02:00
steve donovan 754da6e8d8 usage strings were not HTML-escaped properly (Eric) 2012-12-13 19:18:24 +02:00
steve donovan 8869cf4924 tparam macros can be used in table definitions 2012-12-13 19:17:32 +02:00
steve donovan a551b47085 fallback for type macros in tables (starting). Use label suggested by custom lookup for type names 2012-12-13 15:01:33 +02:00
steve donovan f4b164f24f added --ignore flag (can be in config) to prevent LD from complaining about files with no docs. @submodule implemented 2012-12-10 14:45:54 +02:00
steve donovan ac29c8e9c6 Added Geoff commit by hand: The table parser didn't handle tables with a trailing comment { a=1, 2012-12-10 09:39:12 +02:00
steve donovan 7f6835d253 pl.dir was not imported 2012-12-07 13:08:31 +02:00
steve donovan 5fbe6718ce table field inference borked by recent changes; tests/simple/tables.lua is now behaving better 2012-11-11 18:50:33 +02:00
steve donovan a560d75fde relaxed argcheck-like style without at-signs; see example file 2012-11-08 19:09:59 +02:00
Geoff Leyland 2b304a2252 Use classes for formatting argument descriptions rather than tags 2012-10-29 13:26:07 +13:00
Geoff Leyland 9924e4dced Parse type expressions like '?table|string' and turn them into 'optional table or string' 2012-10-29 13:24:49 +13:00
Geoff Leyland 90e87ece0c Handle multi-line argument descriptions embedded in (and after) a function's formal parameters 2012-10-29 13:22:52 +13:00
Geoff Leyland a2a3da455e Remove requirement to have more than one formal argument when using comments on the arguments. I'm not sure what that was for, so I might have broken something 2012-10-29 13:17:44 +13:00
Geoff Leyland 53166f626f Added a comple of missing requires 2012-10-29 13:14:54 +13:00