steve donovan
7ceb7cc00b
@usage code blocks are prettified
2013-03-05 16:21:54 +02:00
Steve J Donovan
9f52eacb05
Merge pull request #48 from pronebird/master
...
Allow parsing of Objective-C++ sources
2013-03-04 23:42:09 -08:00
Andrej Mihajlov
afedf3fe4b
Add Objective-C++ extension to supported file types
2013-03-04 14:34:34 +01:00
steve donovan
1b67b1cd6f
wrap=true in config.ld will switch off nowrap in name column of function tables
2013-02-13 14:44: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
9021b144b8
usage is now explicitly a multiline tag, so it is not considered part of the description. We are now ignoring Lua comments like so --- some text --- since they're commonly used to indicate logical sections - not for export
2012-12-31 17:02:40 +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
steve donovan
29134ef169
tags as ordered maps; Geoff refactorings
2012-12-29 12:07:26 +02:00
steve donovan
cdebc952e4
usage section is now after returns: bumped vs to 1.3
2012-12-29 12:05:51 +02:00
steve donovan
a3aa4dc979
within tag working; allow description to appear after some tags (needed tags as ordered maps for this)
2012-12-29 12:04:39 +02:00
steve donovan
88d9ee4e8b
--define lets you set conditional flags for config.ld; single module detection improved
2012-12-29 12:01:40 +02:00
steve donovan
7e53497393
updated 1.3 docs
2012-12-29 11:59:30 +02:00
steve donovan
b039ac1574
fix for last Geoff patch (was asleep)
2012-12-28 11:00:10 +02:00
steve donovan
0f68f97513
added support for Luamark (Geoff)
2012-12-28 10:56:43 +02:00
steve donovan
4801a6ba10
export tag gives warnings if an item has not been documented
2012-12-22 16:29:42 +02:00
steve donovan
d51a8d63c9
tables may now have _any_ mix of field and param tags. Fixes hack to permit type macros in table definitions
2012-12-21 19:13:40 +02:00
steve donovan
f54e13185e
tag modifier code not respecting boolean types; export tag now properly makes local functions module-scope
2012-12-21 18:25:06 +02:00
steve donovan
3f70bd16f8
Ignore first non-doc comment (Geoff)
2012-12-21 18:23:18 +02:00
steve donovan
754da6e8d8
usage strings were not HTML-escaped properly (Eric)
2012-12-13 19:18:24 +02:00
steve donovan
8869cf4924
tparam macros can be used in table definitions
2012-12-13 19:17:32 +02:00
steve donovan
a551b47085
fallback for type macros in tables (starting). Use label suggested by custom lookup for type names
2012-12-13 15:01:33 +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
ac29c8e9c6
Added Geoff commit by hand: The table parser didn't handle tables with a trailing comment { a=1,
2012-12-10 09:39:12 +02:00
steve donovan
7f6835d253
pl.dir was not imported
2012-12-07 13:08:31 +02:00
steve donovan
5fbe6718ce
table field inference borked by recent changes; tests/simple/tables.lua is now behaving better
2012-11-11 18:50:33 +02:00
steve donovan
b91adaabc8
cannot use function and table as tparam aliases, because they conflict with existing tag types. So (for now) func and tab..
2012-11-08 19:38:30 +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
53ed04c08d
added standard tparam aliases and a test target
2012-11-07 18:42:16 +02:00
Steve J Donovan
649f91b816
Merge pull request #26 from geoffleyland/master
...
Missing requires; makefile; parameter descriptions; html
2012-11-01 22:36:24 -07:00
Geoff Leyland
2b304a2252
Use classes for formatting argument descriptions rather than tags
2012-10-29 13:26:07 +13:00
Geoff Leyland
9924e4dced
Parse type expressions like '?table|string' and turn them into 'optional table or string'
2012-10-29 13:24:49 +13:00
Geoff Leyland
90e87ece0c
Handle multi-line argument descriptions embedded in (and after) a function's formal parameters
2012-10-29 13:22:52 +13:00
Geoff Leyland
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
Geoff Leyland
53166f626f
Added a comple of missing requires
2012-10-29 13:14:54 +13:00
Geoff Leyland
4de863ca2d
added a makefile to make installing a little simpler
2012-10-29 13:14:03 +13: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
f474eccdf8
factory-style classes: see tests/factory.lua
2012-08-22 12:50:57 +02:00
steve donovan
d69ba1be96
new examples
2012-08-22 12:00:31 +02:00
Steve J Donovan
be1cafba6b
Merge pull request #18 from avnik/master
...
Strip trailing whitespaces from output
2012-08-07 09:21:03 -07:00
Alexander V. Nikolaev
78ffa7e651
Strip trailing whitespaces from output
2012-08-06 16:52:27 +00:00
Steve J Donovan
04c6922eeb
custom see references; Lua 5.2 issue sorted
2012-07-30 12:36:28 -04:00
Nils Nordman
2706d33a94
Allow configuring of backtick_references in config
2012-03-30 21:02:35 +02:00
steve donovan
578f4da1cf
now working with PL strict mode...
2012-03-23 14:21:43 +02:00
steve donovan
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
steve donovan
abd89a1ab8
builtin references are now .lua files for better LuaRocks integration
2012-03-19 15:04:16 +02:00
steve donovan
f9a778e33a
final tweaks to docs, pretty last-line problem
2012-03-19 13:09:01 +02:00