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
|
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
|
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
|
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
|
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 |
|
steve donovan
|
5387084565
|
if a function is explicitly tagged as such, then don't try to further parse the function definition in Lua
|
2011-06-20 13:16:05 +02:00 |
|
steve donovan
|
1ee35487dc
|
updated version number
|
2011-06-19 18:22:48 +02:00 |
|
steve donovan
|
b7e1270b63
|
doc fixes
|
2011-06-19 18:13:36 +02:00 |
|
steve donovan
|
7fe67090a9
|
split readme.md; actual 'manual' is docs/doc.md. Another example added
|
2011-06-19 17:58:15 +02:00 |
|
steve donovan
|
c4ccfd99b5
|
--filter implemented, plus some clean-up
|
2011-06-19 17:53:05 +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
|
41cb7417a8
|
fixed up booboo when dumping out module list in index
|
2011-06-18 11:26:57 +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
|
c9e972c989
|
spoke too soon. Now using _initial_ global state to determine whether to look in Lua global builtin functions
|
2011-06-14 15:04:14 +02:00 |
|
steve donovan
|
451528ddce
|
ldoc -m with builtin finally working properly
|
2011-06-14 15:00:36 +02:00 |
|
steve donovan
|
2487dea7fa
|
global lookup hack for -m was over-hasty
|
2011-06-14 12:24:20 +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
|
2a7cad7be5
|
complete moving template and stylesheet to html
|
2011-06-14 10:58:44 +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 |
|
steve donovan
|
c04993bf20
|
small changes to custom styling demo
|
2011-06-13 19:26:28 +02:00 |
|
steve donovan
|
4642e358fb
|
a custom styling example
|
2011-06-13 15:43:28 +02:00 |
|
steve donovan
|
74b52dacd1
|
starting to track local functions. A module without a starting doc comment is considered an error. A problem with tag warnings crashing ldoc was sorted out. A table or function comment at the end of file could cause a crash.
|
2011-06-13 15:42:42 +02:00 |
|
steve donovan
|
d2d7d6ac38
|
extensive readme changes; more config.ld options
|
2011-06-10 11:44:12 +02:00 |
|
steve donovan
|
fbc283b26c
|
more spacing for dump output; still needs more love
|
2011-06-09 15:07:27 +02:00 |
|
steve donovan
|
298450fb93
|
The invocation 'ldoc .' is treated specially. ./config.ld must exist and can specify the file/directory for the source
|
2011-06-09 12:31:05 +02:00 |
|
steve donovan
|
014c003a1a
|
sections may now have associated descriptions
|
2011-06-08 19:12:04 +02:00 |
|
steve donovan
|
be9c3f2f70
|
Several changes; if a single file is given, the module will be written directly to the output directory (no index). --output can change this name (works). Can define sections
|
2011-06-06 18:38:02 +02:00 |
|
steve donovan
|
74455c089a
|
changes in templates required for supporting Sections
|
2011-06-06 18:35:23 +02:00 |
|
steve donovan
|
3dedea5b49
|
tweak to banner and usage text
|
2011-06-05 19:24:31 +02:00 |
|
steve donovan
|
513f5abe4f
|
add decent <pre> style for Markdown
|
2011-04-28 14:01:08 +02:00 |
|
steve donovan
|
3c99418905
|
markdown does not like being passed nil ;(
|
2011-04-28 13:59:51 +02:00 |
|
steve donovan
|
9541e0274c
|
doc updates
|
2011-04-17 19:12:08 +02:00 |
|
steve donovan
|
de1a2b11ba
|
table fields and their descriptions can be extracted from Lua table definitions
|
2011-04-17 19:01:57 +02:00 |
|
steve donovan
|
1aa717e993
|
refactoring language-specific stuff out of main parser loop
|
2011-04-17 17:41:02 +02:00 |
|
steve donovan
|
a31d590e50
|
new-style modules may have @alias to indicate an internal shorthand for the module
|
2011-04-17 17:06:55 +02:00 |
|
steve donovan
|
f3406df40d
|
anchored tag pattern at start; embedded @ caused mischief
|
2011-04-17 16:56:27 +02:00 |
|
steve donovan
|
f5e2b69cff
|
tag parsing changed: @TAG must start on new line. Also, can handle corner case of first comment not being marked as a doc comment
|
2011-04-17 16:31:28 +02:00 |
|
Steve Donovan
|
7d36bf8c5e
|
ldoc -m module.function now works: output is still very ugly
|
2011-04-14 15:53:48 +02:00 |
|
Steve Donovan
|
5fdf0f484d
|
crash avoided when there's no module doc comment: a warning is issued
|
2011-04-14 15:34:33 +02:00 |