steve donovan
a3cb09c098
Issue #61 sorted - not using Tags.add consistently
2013-05-06 11:38:20 +02:00
steve donovan
68cd576bf4
module deduction can blow up; UTF BOM ignored
2013-04-16 10:11:05 +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
a7b01abd03
module at-references now working! No-contents warning fixed
2013-03-23 17:51:55 +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
357ee3978d
don't strip multiline tag values. Allows multiline @usage blocks to work nicely
2013-03-05 17:00: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
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
29134ef169
tags as ordered maps; Geoff refactorings
2012-12-29 12:07:26 +02:00
steve donovan
3f70bd16f8
Ignore first non-doc comment (Geoff)
2012-12-21 18:23:18 +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
a560d75fde
relaxed argcheck-like style without at-signs; see example file
2012-11-08 19:09:59 +02:00
steve donovan
05727ec0cf
- comments within formal arguments: last comment may be outside the
...
closing parenthesis. If comments are of form TYPE:COMMENT then
equivalent to @tparam not @param. See tests/factory/mymod.lua
- @constructor tag attaches CLASS. as prefix to name
- No more implicit use of "require 'pl'".
2012-10-28 19:51:00 +02:00
steve donovan
578f4da1cf
now working with PL strict mode...
2012-03-23 14:21:43 +02:00
steve donovan
5b4fc640de
@lookup must be first thing; allow for shebang in scripts
2012-03-16 14:42:58 +02:00
steve donovan
87f48c91d3
can now make references to sections (in their underscored form); parser will quietly bail out on empty files
2012-03-13 12:23:55 +02:00
steve donovan
20ddca927d
added classes.lua to config.ld example in tests/
2012-03-06 10:41:19 +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
Fabien
0d1c4d1514
generic support for tag modifiers; modifiers "opt" and "optchain" for tag "param"
2011-10-04 14:54:08 +02:00
steve donovan
a606f6305e
cleaned up some runaway table field detection code, which caused crashes with table items with no declared fields
2011-09-19 19:23:53 +02:00
steve donovan
6e941f576f
support for -- @usage shortcut
2011-09-19 15:53:00 +02:00
steve donovan
40330487b0
@usage tag now works in module comments; annotations were borked
2011-09-19 13:34:01 +02:00
steve donovan
dd881ddcf2
annotations have reference to main parent item
2011-09-18 20:45:36 +02:00
steve donovan
f5c11dcdf5
support for annotations: an item containing one of fixme, todo or warning can appear anywhere in code
2011-09-17 19:13:47 +02:00
steve donovan
e71f7d89ca
phoney error message when bad ref is in module summary sorted; no-doc-comment error now has line number
2011-08-28 15:37:06 +02:00
steve donovan
6832e1de2d
module not added with sensible line number - causes crash on warning
2011-08-27 10:11:41 +02:00
steve donovan
daaf451a7e
LDoc warnings/errrors now use GCC format and are recognized by SciTE
2011-08-26 15:07:35 +02:00
steve donovan
7d9410f094
summary and description fields should now never be nil
2011-08-24 18:32:51 +02:00
steve donovan
8a5261424d
first sentence: ? or . followed by space, or two consecutive linefeeds
2011-08-22 13:26:27 +02:00
steve donovan
e680b44435
tweak to allowing space before :; do not strip linefeed after end of summary.
2011-08-21 18:50:58 +02:00
steve donovan
1befcc505c
problem with parsing explicit module() fixed
2011-08-21 17:29:56 +02:00
steve donovan
e265370400
lexer rewritten to return an object and not a coroutine. Methods like getline() and lineno() now work much better; sorts out problems encountered with Lua block comments
2011-08-14 11:54:40 +02:00
steve donovan
7fa4d6d9eb
if the doc item has an explicit name, don't try to deduce item further
2011-07-30 11:04:54 +02:00
steve donovan
75a6cf14da
line endings sorted out
2011-07-30 11:01:42 +02:00
steve donovan
85728c1947
some generalizations with extended code parsing
2011-07-29 15:55:28 +02:00
steve donovan
88dbcd0d85
module(...) resolution wuz broke; parser needed args.package
2011-07-18 12:07:40 +02:00
steve donovan
aae0c9a5d1
great refactoring: now also prettifies code in Markdown documents
2011-07-12 14:14:55 +02:00