Commit Graph

177 Commits

Author SHA1 Message Date
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
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 74531d7106 presenting Lua methods as Class:name in a @type 2011-09-11 19:17:05 +02:00
steve donovan e71f7d89ca phoney error message when bad ref is in module summary sorted; no-doc-comment error now has line number 2011-08-28 15:37:06 +02:00
steve donovan 6832e1de2d module not added with sensible line number - causes crash on warning 2011-08-27 10:11:41 +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 daaf451a7e LDoc warnings/errrors now use GCC format and are recognized by SciTE 2011-08-26 15:07:35 +02:00
steve donovan 2174f39191 Extended inline ref is now @{name|label}; colon gets confused with method operator 2011-08-25 19:02:06 +02:00
steve donovan 9d126aa2e7 lexer can crash nastily if called beyond end of stream: now always returns nil after the end 2011-08-25 19:00:43 +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 7d9410f094 summary and description fields should now never be nil 2011-08-24 18:32:51 +02:00
steve donovan 8a5261424d first sentence: ? or . followed by space, or two consecutive linefeeds 2011-08-22 13:26:27 +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 e680b44435 tweak to allowing space before :; do not strip linefeed after end of summary. 2011-08-21 18:50:58 +02:00
steve donovan 1befcc505c problem with parsing explicit module() fixed 2011-08-21 17:29:56 +02:00
steve donovan 80e2e1e112 lorenzo's suggestion; may optionally provide text for the reference link using a colon 2011-08-21 17:25:28 +02:00
steve donovan 87784490fc track line numbers in full text mode by counting linefeeds in spaces and comments 2011-08-21 17:23:58 +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 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 7fa4d6d9eb if the doc item has an explicit name, don't try to deduce item further 2011-07-30 11:04:54 +02:00
steve donovan 75a6cf14da line endings sorted out 2011-07-30 11:01:42 +02:00
steve donovan 85728c1947 some generalizations with extended code parsing 2011-07-29 15:55:28 +02:00
steve donovan bedb89a307 initial blank line makes lexer give up 2011-07-29 15:54:23 +02:00
steve donovan 1dc062dafb extending code inferrence patterns 2011-07-29 15:53:45 +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 1735332b96 check_file now copies the file up if it is newer 2011-07-14 15:23:55 +02:00
steve donovan da13ae5942 handle [=[...]=] comments and strings 2011-07-14 15:23:20 +02:00
steve donovan a41792c56c better support for one-column style 2011-07-12 15:42:58 +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 d864e49f47 lexer would hang on an empty file 2011-07-11 09:34:18 +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 7839a791ae code reformat 4 to 3 spaces per indent 2011-07-10 19:10:53 +02:00
steve donovan 6935affe05 one-column stylesheet by Lorenzo; initial prettification for examples 2011-07-08 16:01:05 +02:00
steve donovan acaa57c6b6 handling of strings was borked 2011-07-08 16:00:21 +02:00
steve donovan 684b5f350e provision for looking up class method names; only explicit modules have their names adjusted for package.mod 2011-07-08 15:59:56 +02:00
steve donovan 4d718d3e86 Inline references are now @{ref}, not <ref> 2011-07-07 14:29:27 +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 99cfca7643 attempt to tame markdown.lua's need for blank lines around lists; it is not doing nested lists correctly (throwing in <p> inside <li>) 2011-07-05 18:53:28 +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 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 3ca03ea818 lexer could not cope with zero length file 2011-06-21 18:30:57 +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 5c8a9d1e72 nasty typo caused crash on table definitions. (borked commit) 2011-06-18 11:45:45 +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
steve donovan ad2a350806 separate out language-specific parsing strategies 2011-06-16 11:09:24 +02:00
steve donovan 7c02820692 initial implementation of -all flag; default is to hide local functions from documentation 2011-06-15 16:33:13 +02:00
steve donovan c57c364335 @local tag to flag a function explicitly as local 2011-06-15 16:12:56 +02:00
steve donovan d4c04661ba ldoc -m now falls back on the Lua documentation in builtin directory; concept of 'doc path' introduced. 2011-06-14 11:36:05 +02:00
steve donovan e62bec5b81 complete moving source 2011-06-14 10:54:51 +02:00
steve donovan 19b0be5e71 moved modules to ldoc, templates to html 2011-06-14 10:52:10 +02:00