Commit Graph

82 Commits

Author SHA1 Message Date
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 abd89a1ab8 builtin references are now .lua files for better LuaRocks integration 2012-03-19 15:04:16 +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 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 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 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 de7fef1c45 creating an alias for a tparam TYPE tags 2012-03-04 18:57:17 +02:00
steve donovan 6c3c19f3bf ldoc.readme can be multiple; ldoc.topics is a synonym. 2012-03-04 18:42:50 +02:00
steve donovan edd4a6b35e Lua 5.2 compatibility changes - now working fine so far 2012-02-29 19:20:57 +02:00
steve donovan 5422edcffe 1.1.0 beta push 2011-12-21 15:04:16 +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 70e1f22909 tparam/treturn aliases for type modifiers: display of types with standard template 2011-12-06 19:19:09 +02:00
steve donovan 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
steve donovan d55323812f doc typos 2011-09-26 12:47:13 +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 1dd35e86a0 great renaming: moved everything into ldoc module tree 2011-09-20 12:59:34 +02:00
steve donovan 86dd93e67c prepare ldoc.lua for self-documentation 2011-09-19 15:53:43 +02:00
steve donovan 8ad081317e manual_url _function_ in config.ld can specify another location for the Lua manual file:///D:/dev/lua/projects/lua-5.1.4/doc/manual.html 2011-09-19 14:42:54 +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 dd881ddcf2 annotations have reference to main parent item 2011-09-18 20:45:36 +02:00
steve donovan 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
steve donovan 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
steve donovan 7be49eace7 errors in config file now cause message & quit 2011-09-11 17:47:34 +02:00
steve donovan 7c3f43349f --tags broke ldoc! The new builtins are fixme, todo and warning, and the old tags author, license and copyright also work 2011-08-26 15:41:38 +02:00
steve donovan 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
steve donovan 094852da4c default template and style sheets now loaded as Lua modules, to get no-fuss LuaRocks install. 2011-08-22 12:54:32 +02:00
steve donovan 226d3d372c -c option may be given relative or absolute path to configuration file; file references in this file will be relative to its position 2011-08-21 19:01:31 +02:00
steve donovan 9b373e36aa need explicit 'extended_markdown' in config to do pre-processing. This feature is currently not working 100% 2011-07-30 11:06:42 +02:00
steve donovan eb15776a9b throw error if unrecognized fields used in config.ld; examples field may now be a string; needed to normalize paths on Windows 2011-07-29 15:52:16 +02:00
steve donovan 88dbcd0d85 module(...) resolution wuz broke; parser needed args.package 2011-07-18 12:07:40 +02:00
steve donovan 0b181d3b66 ldoc.output was not set before the index 2011-07-14 15:27:16 +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 ebc7c4e22f ldoc.files and ldoc.examples can have field 2011-07-11 09:59:10 +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 7ae455c006 implement --one: refactoring for examples support 2011-07-08 15:58:40 +02:00
steve donovan c727f0106c can specify configuration file with --config parameter 2011-07-07 14:28:41 +02:00
steve donovan e786e6beac generalizations: <ref> can also be used w/out Markdown. Options to switch off various parts of the template 2011-07-06 15:24:05 +02:00
steve donovan efd03cccb3 Markdown preprocess: consistently indented blocks are given paragraph break lines around them. Use ldoc.classic_markdown to switch off 2011-07-06 11:49:24 +02:00
steve donovan 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
steve donovan e21db67984 factoring out custom markup processing 2011-07-05 16:30:49 +02:00
steve donovan 2810c4804a conditional fix for Penlight 0.9.5; uses loadin() if available 2011-07-05 13:33:27 +02:00
steve donovan 3169b6482f the new name for index (args.output) will be used for index refernces as well 2011-07-03 18:22:45 +02:00
steve donovan 2a07ffc7d0 refactored file processing so that args.file can be set from config as a list of files or directories 2011-07-03 10:24:14 +02:00
steve donovan 20498f3ad7 making better error messages 2011-06-21 18:39:38 +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 f2fc6f1604 can now use package field in config.ld. tests/luadoc contains a suitable setup for processing LuaDoc itself correctly 2011-06-20 19:04:21 +02:00