Commit Graph

53 Commits

Author SHA1 Message Date
mpeterv 8bc3700377 Use dir.makepath when creating output directory
Don't exit with error if an intermediate directory doesn't exist.
Also, handle directory creation failure.
2016-07-01 14:48:05 +03:00
steve donovan f09d617005 always write output with lf line endings 2016-06-20 18:50:07 +02:00
steve donovan 1ebd148291 allow [int] in table documentation - http://stackoverflow.com/questions/36419386/lua-ldoc-documentation-of-a-table 2016-04-10 16:54:33 +02:00
Mooffie 24a6b27338 Have CSS classes for section header and description 2014-12-16 12:08:08 +02:00
Steve Donovan acc6ed2ad3 prettify code blocks in module docstring. Two new ldoc flags: dont_escape_underscore (when not using markdown.lua) and global_lookup (when specifically wanting global lookup for single symbols 2014-06-20 15:11:40 +02:00
Steve Donovan 251dc88f93 deterministic ordered file processing 2014-04-23 10:20:55 +02:00
Steve Donovan 4294b2e2da Issue #114: trying harder to resolve references by unqualified method name 2013-11-28 11:57:13 +02:00
steve donovan fd323aa286 Issue #105; can switch off auto-linking to Lua manual with 'no_lua_ref' variable. This also happens if plain C documentation is being generated 2013-11-16 20:36:53 +02:00
Steve Donovan d2e40e2f2f basic support for documenting C. If you put 'parse_extra={C=true}' in config.ld, then it will attempt to extract function name, arguments and types from the source 2013-09-20 13:33:06 +02:00
Steve Donovan a162c4b9e9 a list of comma-separated items can appear after a see tag; fixed problem with references to Lua global functions from last commit 2013-08-21 15:52:53 +02:00
Steve Donovan 3e78c4704b partial file list sorting refactor was borked 2013-08-07 13:33:38 +02:00
Steve Donovan 5dd69b90bf support for Moonscript fat vs thin arrows; tools.get_parameters also returns last token found; lang.method_call generalization 2013-08-07 11:05:55 +02:00
Steve Donovan b87180996d Moonscript: support for modules using with statement; optionally ignore colon as part of an identifier 2013-08-07 09:53:39 +02:00
Steve Donovan adcd9c5ede better soln for issue #73: partial sorting for all processed files 2013-08-02 14:18:41 +02:00
Steve Donovan 7fe6a95544 a partial solution for issue #73: ldoc.module_file to pick master modules when present 2013-08-01 12:14:57 +02:00
Steve Donovan 8a071fb517 issue #64: use 'sort=true' in config.ld to sort items in sections 2013-07-31 14:25:33 +02:00
steve donovan 4208b21234 issue #65; see references no longer have multiple option, but can now allow custom formats 2013-05-27 14:47:26 +02:00
steve donovan 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
steve donovan 394ba636bc link fix in docs and anti-global jihad 2013-02-13 14:15:29 +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 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 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 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 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 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 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 70e1f22909 tparam/treturn aliases for type modifiers: display of types with standard template 2011-12-06 19:19:09 +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 f1b7c894f7 _properly_ handle arb Lua block comments; now passes the embedded block comment test 2011-08-25 18:59:28 +02:00
steve donovan f1bdccefd2 general Lua long comments allowed, e.g --[=[ 2011-08-24 18:57:53 +02:00
steve donovan e265370400 lexer rewritten to return an object and not a coroutine. Methods like getline() and lineno() now work much better; sorts out problems encountered with Lua block comments 2011-08-14 11:54:40 +02:00
steve donovan f5504a345a quote strings in long comment blocks. This continues an already nasty hack which we need to retire pronto 2011-07-30 11:07:26 +02:00
steve donovan 85728c1947 some generalizations with extended code parsing 2011-07-29 15:55:28 +02:00
steve donovan 1735332b96 check_file now copies the file up if it is newer 2011-07-14 15:23:55 +02:00
steve donovan aae0c9a5d1 great refactoring: now also prettifies code in Markdown documents 2011-07-12 14:14:55 +02:00
steve donovan 788d8f24bd Topics working with section references; cross-references starting to work 2011-07-11 15:40:44 +02:00
steve donovan 42cb80be25 examples starting to work: factoring looking-up addresses out of template 2011-07-10 19:12:35 +02:00
steve donovan fb98cc767d (1) pattern for @see references did not include underscore (2) hack for grabbing block comment foiled by '--]]' 2011-07-03 10:26:24 +02:00
steve donovan 4fd3c78388 more useful message if template is not found: utils.quit() borked 2011-06-21 18:02:21 +02:00
steve donovan 7b69e259fd workaround for PL bug on Windows with relative paths: path.normcase is borked 2011-06-21 17:47:48 +02:00
steve donovan 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
steve donovan 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