53ed04c08d
added standard tparam aliases and a test target
2012-11-07 18:42:16 +02:00
649f91b816
Merge pull request #26 from geoffleyland/master
...
Missing requires; makefile; parameter descriptions; html
2012-11-01 22:36:24 -07:00
2b304a2252
Use classes for formatting argument descriptions rather than tags
2012-10-29 13:26:07 +13:00
9924e4dced
Parse type expressions like '?table|string' and turn them into 'optional table or string'
2012-10-29 13:24:49 +13:00
90e87ece0c
Handle multi-line argument descriptions embedded in (and after) a function's formal parameters
2012-10-29 13:22:52 +13:00
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
53166f626f
Added a comple of missing requires
2012-10-29 13:14:54 +13:00
4de863ca2d
added a makefile to make installing a little simpler
2012-10-29 13:14:03 +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
d69ba1be96
new examples
2012-08-22 12:00:31 +02:00
be1cafba6b
Merge pull request #18 from avnik/master
...
Strip trailing whitespaces from output
2012-08-07 09:21:03 -07:00
78ffa7e651
Strip trailing whitespaces from output
2012-08-06 16:52:27 +00:00
04c6922eeb
custom see references; Lua 5.2 issue sorted
2012-07-30 12:36:28 -04:00
2706d33a94
Allow configuring of backtick_references in config
2012-03-30 21:02:35 +02:00
578f4da1cf
now working with PL strict mode...
2012-03-23 14:21:43 +02:00
9bf51e3294
@ lookup can now happen on main page, and we now have a LuaRocks-agnostic way of finding builtin references
2012-03-19 19:07:11 +02:00
abd89a1ab8
builtin references are now .lua files for better LuaRocks integration
2012-03-19 15:04:16 +02:00
f9a778e33a
final tweaks to docs, pretty last-line problem
2012-03-19 13:09:01 +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
5b4fc640de
@lookup must be first thing; allow for shebang in scripts
2012-03-16 14:42:58 +02:00
9f314ea7fc
documentation overhaul
2012-03-16 14:41:26 +02:00
967dd60139
revamping docs; kind sort order in documents
2012-03-15 15:06:30 +02:00
d65ebf9ddf
1. Improved multiple Topic support; can refer to Sections
...
2. In output, similar animals of the same kind are moved to the front
3. 'content' div has fixed width of 700px
4. @lookup directive in documents
5. Irritating trailing line removed in prettified blocks
2012-03-14 11:38:54 +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
9d0d12c31a
refs to Lua 5.2 docs (if we are using 5.2) and bumped up major version to 1.2
2012-03-13 10:37:07 +02:00
20ddca927d
added classes.lua to config.ld example in tests/
2012-03-06 10:41:19 +02:00
536ee894d2
do not prepend class qualifier (Fred:) if the name already contains it
2012-03-06 10:39:33 +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
3ed4e1f942
references in markdown-style backticks will be resolved, default true if using markdown. Set ldoc.backtick_references to be explicit.
2012-03-04 18:46:02 +02:00
6c3c19f3bf
ldoc.readme can be multiple; ldoc.topics is a synonym.
2012-03-04 18:42:50 +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
c8f556804e
Merge branch 'master' of github.com:stevedonovan/LDoc
2012-02-29 19:21:40 +02:00
edd4a6b35e
Lua 5.2 compatibility changes - now working fine so far
2012-02-29 19:20:57 +02:00
a811dfa5f4
Merge branch 'master' of github.com:stevedonovan/LDoc
2012-01-09 15:12:53 +02:00
725e49f50e
malformed ref check did not allow - (in example file names)
2012-01-09 14:07:24 +02:00
5422edcffe
1.1.0 beta push
2011-12-21 15:04:16 +02:00
444a3d9ce3
directory clean out
2011-12-17 17:08:00 +02:00
461fe4b711
fixed typo, dammit
2011-12-13 14:16:03 +02:00
fb5f5f290c
allow fallback from discount format to markdown
2011-12-12 15:48:35 +02:00
c0d7c6d0ac
clearer messages when switching to another directory
2011-12-12 13:15:04 +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
69a952b76b
fallback troubleshooting code for now
2011-12-06 19:20:17 +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
50b4e733eb
new Penlight puts Lua 5.2-style load in utils table; now checking for this case, preserving compatibility
2011-10-04 15:37:14 +02:00
0d1c4d1514
generic support for tag modifiers; modifiers "opt" and "optchain" for tag "param"
2011-10-04 14:54:08 +02:00
d55323812f
doc typos
2011-09-26 12:47:13 +02:00
steve donovan
Geoff Leyland
Alexander V. Nikolaev
Nils Nordman
Fabien