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 |
|
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
|
c4ccfd99b5
|
--filter implemented, plus some clean-up
|
2011-06-19 17:53:05 +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
|
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
|
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
|
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
|
3dedea5b49
|
tweak to banner and usage text
|
2011-06-05 19:24:31 +02:00 |
|
steve donovan
|
3c99418905
|
markdown does not like being passed nil ;(
|
2011-04-28 13:59:51 +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 |
|
steve donovan
|
8aabee8cd2
|
a --dump debug flag is available; useful for testing
|
2011-04-13 18:45:41 +02:00 |
|
steve donovan
|
daaa2d1208
|
prevent crash if C extension module name not specified
|
2011-04-13 18:22:28 +02:00 |
|
steve donovan
|
0e36a20ca4
|
factored out Lua-specific function name/parms deduction
|
2011-04-13 18:18:39 +02:00 |
|
steve donovan
|
770edb40c0
|
doc comments should not IMHO apply to local functions
|
2011-04-13 18:12:56 +02:00 |
|
Steve Donovan
|
57b9b7020b
|
default output directory is 'docs', not '.'
|
2011-04-13 13:04:17 +02:00 |
|
steve donovan
|
73e22a3c6c
|
initial commit
|
2011-04-12 19:07:47 +02:00 |