05727ec0cf
- comments within formal arguments: last comment may be outside the
...
closing parenthesis. If comments are of form TYPE:COMMENT then
equivalent to @tparam not @param. See tests/factory/mymod.lua
- @constructor tag attaches CLASS. as prefix to name
- No more implicit use of "require 'pl'".
2012-10-28 19:51:00 +02:00
04c6922eeb
custom see references; Lua 5.2 issue sorted
2012-07-30 12:36:28 -04:00
2706d33a94
Allow configuring of backtick_references in config
2012-03-30 21:02:35 +02:00
578f4da1cf
now working with PL strict mode...
2012-03-23 14:21:43 +02:00
abd89a1ab8
builtin references are now .lua files for better LuaRocks integration
2012-03-19 15:04:16 +02:00
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
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
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
cb7426005b
topics alias now ok; don't emit <code> with backtick-references; update types.lua example
2012-03-05 15:34:16 +02:00
de7fef1c45
creating an alias for a tparam TYPE tags
2012-03-04 18:57:17 +02:00
6c3c19f3bf
ldoc.readme can be multiple; ldoc.topics is a synonym.
2012-03-04 18:42:50 +02:00
edd4a6b35e
Lua 5.2 compatibility changes - now working fine so far
2012-02-29 19:20:57 +02:00
5422edcffe
1.1.0 beta push
2011-12-21 15:04:16 +02:00
c0d7c6d0ac
clearer messages when switching to another directory
2011-12-12 13:15:04 +02:00
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
70e1f22909
tparam/treturn aliases for type modifiers: display of types with standard template
2011-12-06 19:19:09 +02:00
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
d55323812f
doc typos
2011-09-26 12:47:13 +02:00
88326dc668
update builtin luadoc; tweaks to template
2011-09-22 15:48:09 +02:00
fbbdba7ecf
documenting customizing options; problem with no_summary fixed
2011-09-21 15:50:11 +02:00
1dd35e86a0
great renaming: moved everything into ldoc module tree
2011-09-20 12:59:34 +02:00
86dd93e67c
prepare ldoc.lua for self-documentation
2011-09-19 15:53:43 +02:00
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
40330487b0
@usage tag now works in module comments; annotations were borked
2011-09-19 13:34:01 +02:00
dd881ddcf2
annotations have reference to main parent item
2011-09-18 20:45:36 +02:00
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
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
7be49eace7
errors in config file now cause message & quit
2011-09-11 17:47:34 +02:00
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
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
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
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
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
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
88dbcd0d85
module(...) resolution wuz broke; parser needed args.package
2011-07-18 12:07:40 +02:00
0b181d3b66
ldoc.output was not set before the index
2011-07-14 15:27:16 +02:00
aae0c9a5d1
great refactoring: now also prettifies code in Markdown documents
2011-07-12 14:14:55 +02:00
788d8f24bd
Topics working with section references; cross-references starting to work
2011-07-11 15:40:44 +02:00
ebc7c4e22f
ldoc.files and ldoc.examples can have field
2011-07-11 09:59:10 +02:00
42cb80be25
examples starting to work: factoring looking-up addresses out of template
2011-07-10 19:12:35 +02:00
7ae455c006
implement --one: refactoring for examples support
2011-07-08 15:58:40 +02:00
c727f0106c
can specify configuration file with --config parameter
2011-07-07 14:28:41 +02:00
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
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
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
e21db67984
factoring out custom markup processing
2011-07-05 16:30:49 +02:00
2810c4804a
conditional fix for Penlight 0.9.5; uses loadin() if available
2011-07-05 13:33:27 +02:00
3169b6482f
the new name for index (args.output) will be used for index refernces as well
2011-07-03 18:22:45 +02:00
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
20498f3ad7
making better error messages
2011-06-21 18:39:38 +02:00
4fd3c78388
more useful message if template is not found: utils.quit() borked
2011-06-21 18:02:21 +02:00
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
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
1ee35487dc
updated version number
2011-06-19 18:22:48 +02:00
c4ccfd99b5
--filter implemented, plus some clean-up
2011-06-19 17:53:05 +02:00
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
ad2a350806
separate out language-specific parsing strategies
2011-06-16 11:09:24 +02:00
7c02820692
initial implementation of -all flag; default is to hide local functions from documentation
2011-06-15 16:33:13 +02:00
c57c364335
@local tag to flag a function explicitly as local
2011-06-15 16:12:56 +02:00
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
451528ddce
ldoc -m with builtin finally working properly
2011-06-14 15:00:36 +02:00
2487dea7fa
global lookup hack for -m was over-hasty
2011-06-14 12:24:20 +02:00
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
2a7cad7be5
complete moving template and stylesheet to html
2011-06-14 10:58:44 +02:00
e62bec5b81
complete moving source
2011-06-14 10:54:51 +02:00
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
d2d7d6ac38
extensive readme changes; more config.ld options
2011-06-10 11:44:12 +02:00
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
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
3dedea5b49
tweak to banner and usage text
2011-06-05 19:24:31 +02:00
3c99418905
markdown does not like being passed nil ;(
2011-04-28 13:59:51 +02:00
de1a2b11ba
table fields and their descriptions can be extracted from Lua table definitions
2011-04-17 19:01:57 +02:00
1aa717e993
refactoring language-specific stuff out of main parser loop
2011-04-17 17:41:02 +02:00
a31d590e50
new-style modules may have @alias to indicate an internal shorthand for the module
2011-04-17 17:06:55 +02:00
f3406df40d
anchored tag pattern at start; embedded @ caused mischief
2011-04-17 16:56:27 +02:00
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
7d36bf8c5e
ldoc -m module.function now works: output is still very ugly
2011-04-14 15:53:48 +02:00
5fdf0f484d
crash avoided when there's no module doc comment: a warning is issued
2011-04-14 15:34:33 +02:00
8aabee8cd2
a --dump debug flag is available; useful for testing
2011-04-13 18:45:41 +02:00
daaa2d1208
prevent crash if C extension module name not specified
2011-04-13 18:22:28 +02:00
0e36a20ca4
factored out Lua-specific function name/parms deduction
2011-04-13 18:18:39 +02:00
770edb40c0
doc comments should not IMHO apply to local functions
2011-04-13 18:12:56 +02:00
57b9b7020b
default output directory is 'docs', not '.'
2011-04-13 13:04:17 +02:00
73e22a3c6c
initial commit
2011-04-12 19:07:47 +02:00
steve donovan
Nils Nordman