Commit Graph

287 Commits

Author SHA1 Message Date
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 c694526232 updating docs 2011-09-20 12:53:31 +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 86dd93e67c prepare ldoc.lua for self-documentation 2011-09-19 15:53:43 +02:00
steve donovan 6e941f576f support for -- @usage shortcut 2011-09-19 15:53:00 +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 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 88b9a97cb1 building ldoc documentation 2011-09-18 20:45:55 +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 a177ceaa59 doc updates 2011-09-11 19:16:00 +02:00
steve donovan 7be49eace7 errors in config file now cause message & quit 2011-09-11 17:47:34 +02:00
steve donovan a418859589 updating documentation 2011-09-01 16:00:16 +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 def3cc398a do not put out an index backlink on the actual index page 2011-08-26 15:45:56 +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 daaf451a7e LDoc warnings/errrors now use GCC format and are recognized by SciTE 2011-08-26 15:07:35 +02:00
steve donovan 5b9bb58a3e updated test 2011-08-25 19:02:43 +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 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 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 779ce4bb51 example of using --package ... to generate luadoc documentation correctly 2011-08-14 11:50:36 +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 b1a856d9e7 doc updates 2011-07-29 15:52:31 +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 5e77edc33a example now uses @{refs} 2011-07-18 12:08:24 +02:00