Commit Graph

109 Commits

Author SHA1 Message Date
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 a560d75fde relaxed argcheck-like style without at-signs; see example file 2012-11-08 19:09:59 +02: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
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
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
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
steve donovan 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
steve donovan 5b4fc640de @lookup must be first thing; allow for shebang in scripts 2012-03-16 14:42:58 +02:00
steve donovan 9f314ea7fc documentation overhaul 2012-03-16 14:41:26 +02:00
steve donovan 967dd60139 revamping docs; kind sort order in documents 2012-03-15 15:06:30 +02:00
steve donovan 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
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 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
steve donovan 20ddca927d added classes.lua to config.ld example in tests/ 2012-03-06 10:41:19 +02:00
steve donovan 536ee894d2 do not prepend class qualifier (Fred:) if the name already contains it 2012-03-06 10:39:33 +02:00
steve donovan cb7426005b topics alias now ok; don't emit <code> with backtick-references; update types.lua example 2012-03-05 15:34:16 +02:00
steve donovan 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
steve donovan 38c8f187b3 improved varargs support; updated example to show this and tparam usage 2012-03-02 13:19:34 +02:00
steve donovan ecd6b4cfa5 changes to varargs matching 2012-03-01 20:08:55 +02:00
steve donovan 725e49f50e malformed ref check did not allow - (in example file names) 2012-01-09 14:07:24 +02:00
steve donovan 461fe4b711 fixed typo, dammit 2011-12-13 14:16:03 +02:00
steve donovan fb5f5f290c allow fallback from discount format to markdown 2011-12-12 15:48:35 +02:00
steve donovan c0d7c6d0ac clearer messages when switching to another directory 2011-12-12 13:15:04 +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 69a952b76b fallback troubleshooting code for now 2011-12-06 19:20:17 +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
steve donovan 3d8cdadc88 tried to access modifiers when not present 2011-10-04 15:54:08 +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 88326dc668 update builtin luadoc; tweaks to template 2011-09-22 15:48:09 +02:00
steve donovan fbbdba7ecf documenting customizing options; problem with no_summary fixed 2011-09-21 15:50:11 +02:00
steve donovan 746eecc979 doc updates: @plain for switching off code block prettification 2011-09-20 15:59:34 +02:00
steve donovan 4a0b997975 doc updates: escaping @{} 2011-09-20 14:11:31 +02:00
steve donovan 1dd35e86a0 great renaming: moved everything into ldoc module tree 2011-09-20 12:59:34 +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 1a2e61a1f9 prettifying code in readme 2011-09-19 14:22:18 +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 2b54ad1627 mark global functions and tables when prettifying code 2011-09-19 13:32:30 +02:00