741cba8ff2
merging trailing [opt] as [optchain]s. Trying to solve 'self' references in modules
2013-03-20 14:41:54 +02:00
65723a9dc4
issue #57 : [opt=default] support - see tests/styles/four.lua
2013-03-19 15:00:57 +02:00
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
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
dee7cd200a
fixed issue #47 ; flag-style tags like @local were blowing up with description collection
2013-03-07 13:49:39 +02:00
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
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
987c5fbc9c
examples of syntax highlighting in function @usage blocks; 'static' member functions
2013-03-05 17:57:55 +02:00
55bbeed4f4
added module merging - see tests/merge directory (--merge flag)
2013-01-28 11:23:31 +02:00
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
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
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
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
5fbe6718ce
table field inference borked by recent changes; tests/simple/tables.lua is now behaving better
2012-11-11 18:50:33 +02:00
a560d75fde
relaxed argcheck-like style without at-signs; see example file
2012-11-08 19:09:59 +02:00
53ed04c08d
added standard tparam aliases and a test target
2012-11-07 18:42:16 +02:00
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
f474eccdf8
factory-style classes: see tests/factory.lua
2012-08-22 12:50:57 +02:00
d69ba1be96
new examples
2012-08-22 12:00:31 +02:00
27fcd4d5fc
Do not resolve references when using -m. Can now use @treturn just with a type (pattern fix). Default dump more structured.
2012-03-17 12:17:22 +02:00
20ddca927d
added classes.lua to config.ld example in tests/
2012-03-06 10:41:19 +02:00
cb7426005b
topics alias now ok; don't emit <code> with backtick-references; update types.lua example
2012-03-05 15:34:16 +02:00
de7fef1c45
creating an alias for a tparam TYPE tags
2012-03-04 18:57:17 +02:00
38c8f187b3
improved varargs support; updated example to show this and tparam usage
2012-03-02 13:19:34 +02:00
444a3d9ce3
directory clean out
2011-12-17 17:08:00 +02:00
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
70e1f22909
tparam/treturn aliases for type modifiers: display of types with standard template
2011-12-06 19:19:09 +02:00
5b9bb58a3e
updated test
2011-08-25 19:02:43 +02:00
e680b44435
tweak to allowing space before :; do not strip linefeed after end of summary.
2011-08-21 18:50:58 +02:00
5e77edc33a
example now uses @{refs}
2011-07-18 12:08:24 +02:00
c1c507c2a7
examples updated
2011-07-06 11:49:50 +02:00
8e791b8be6
new md test
2011-07-05 20:19:48 +02:00
f2fc6f1604
can now use package field in config.ld. tests/luadoc contains a suitable setup for processing LuaDoc itself correctly
2011-06-20 19:04:21 +02:00
7fe67090a9
split readme.md; actual 'manual' is docs/doc.md. Another example added
2011-06-19 17:58:15 +02:00
c04993bf20
small changes to custom styling demo
2011-06-13 19:26:28 +02:00
4642e358fb
a custom styling example
2011-06-13 15:43:28 +02:00
de1a2b11ba
table fields and their descriptions can be extracted from Lua table definitions
2011-04-17 19:01:57 +02:00
a31d590e50
new-style modules may have @alias to indicate an internal shorthand for the module
2011-04-17 17:06:55 +02:00
5fdf0f484d
crash avoided when there's no module doc comment: a warning is issued
2011-04-14 15:34:33 +02:00
05bd15a266
convert to sensible line feeds
2011-04-13 13:02:40 +02:00
73e22a3c6c
initial commit
2011-04-12 19:07:47 +02:00
steve donovan