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
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
04c6922eeb
custom see references; Lua 5.2 issue sorted
2012-07-30 12:36:28 -04:00
578f4da1cf
now working with PL strict mode...
2012-03-23 14:21:43 +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
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
536ee894d2
do not prepend class qualifier (Fred:) if the name already contains it
2012-03-06 10:39:33 +02:00
38c8f187b3
improved varargs support; updated example to show this and tparam usage
2012-03-02 13:19:34 +02:00
ecd6b4cfa5
changes to varargs matching
2012-03-01 20:08:55 +02:00
725e49f50e
malformed ref check did not allow - (in example file names)
2012-01-09 14:07:24 +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
3d8cdadc88
tried to access modifiers when not present
2011-10-04 15:54:08 +02:00
0d1c4d1514
generic support for tag modifiers; modifiers "opt" and "optchain" for tag "param"
2011-10-04 14:54:08 +02:00
1dd35e86a0
great renaming: moved everything into ldoc module tree
2011-09-20 12:59:34 +02:00
40330487b0
@usage tag now works in module comments; annotations were borked
2011-09-19 13:34:01 +02:00
dd881ddcf2
annotations have reference to main parent item
2011-09-18 20:45:36 +02:00
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
c370529976
getting line numbers right for warnings in examples and topics; formatting function takes explicit item argument (no longer part of ldoc state)
2011-09-17 17:57:22 +02:00
74531d7106
presenting Lua methods as Class:name in a @type
2011-09-11 19:17:05 +02:00
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
8d22dc7b2c
new flag --tags and some more builtin tags. So --tag fixme will show all occurances of @fixme in a project
2011-08-26 15:34:42 +02:00
daaf451a7e
LDoc warnings/errrors now use GCC format and are recognized by SciTE
2011-08-26 15:07:35 +02:00
aae0c9a5d1
great refactoring: now also prettifies code in Markdown documents
2011-07-12 14:14:55 +02:00
788d8f24bd
Topics working with section references; cross-references starting to work
2011-07-11 15:40:44 +02:00
684b5f350e
provision for looking up class method names; only explicit modules have their names adjusted for package.mod
2011-07-08 15:59:56 +02:00
5e891d8d7c
Can now have <<REF>> inside Markdown-flavoured ldoc, which use the same rules for
...
REF as with @see references. References within a single module document must be
to the name of the document from args.output, not the module name.
2011-07-05 18:19:49 +02:00
f55838ede0
keep a table of globals; used for ldoc -m and for resolving @see references to Lua standard library functions and tables
2011-06-19 17:52:02 +02:00
98b0617d34
module name inference (1) 'mod/init.lua' is 'mod' (2) either M or _M are used as default alias values for 'new-style' modules
2011-06-16 16:44:46 +02:00
7c02820692
initial implementation of -all flag; default is to hide local functions from documentation
2011-06-15 16:33:13 +02:00
c57c364335
@local tag to flag a function explicitly as local
2011-06-15 16:12:56 +02:00
e62bec5b81
complete moving source
2011-06-14 10:54:51 +02:00
19b0be5e71
moved modules to ldoc, templates to html
2011-06-14 10:52:10 +02:00
Geoff Leyland
steve donovan
Fabien