Commit Graph

29 Commits

Author SHA1 Message Date
Steve Donovan b248a2e035 Modifications to pull #207; enable backward compatibility and fixed spelling mistake 2015-09-28 15:33:18 +02:00
steve donovan 3f653cf0a8 issue #171 doc updates 2014-10-15 18:20:55 +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 c34957cd16 issue #178 Allow class merging 2014-09-28 18:54:17 +02:00
steve donovan 3f32313ced #158 summary line lost with @type tag 2014-05-25 13:58:25 +02:00
Steve Donovan 1f21b5efa3 workaround for Lua file methods #157 2014-04-23 13:38:58 +02:00
steve donovan f507e36720 more general method of controlling visibility of local functions or items marked with @local 2014-01-02 18:45:04 +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 df72613e57 structure return needs 'typename'; by default merge_error_groups will combine different error tag texts 2013-08-27 12:47:47 +02:00
Steve Donovan 8395d6d9d7 inline error comments starting to work 2013-08-26 14:22:52 +02:00
Steve Donovan a825a316a1 error tag now auto-groups; refactorings 2013-08-26 13:37:41 +02:00
Steve Donovan 0d79e16706 PL utils.unpack compatibility; refactoring error 'tag' 2013-08-26 09:59:10 +02:00
steve donovan 149ded81fc composite return types experiment 2013-08-25 10:47:45 +02:00
steve donovan 3c72ea112e ldoc.alias can specify a function which must return tag, value, modifiers like Item:check_tag. The alias error works with return groups 2013-08-24 15:19:45 +02:00
Steve Donovan 1bf3461917 doc updates 2013-08-23 15:59:35 +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 dfdac3f977 fix #84; also no_space_before_args=false to stop ldoc putting space between name and arglist of functions 2013-08-20 15:26:49 +02:00
steve donovan cf7b8e3a9a fixes issue #62: keep LuaDoc compatibility, unless not_luadoc is explicitly set 2013-05-09 13:28:39 +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 a3cb09c098 Issue #61 sorted - not using Tags.add consistently 2013-05-06 11:38:20 +02:00
steve donovan 6d22818ec9 allow -c to be used with explicit file 2013-04-11 15:37:01 +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 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 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