9b40e03e3a
Command-line flags that were explicitly passed by the user should take precedence over config file defaults.
2013-12-21 00:41:41 -02:00
3053079fee
Custom display_name handler.
2013-12-09 12:23:27 +02:00
89854e1537
Custom tags
...
Custom tags
2013-11-28 10:46:59 -05:00
63e3618c05
Issue #110 ; use '-u' or 'unqualified' explicitly to strip package names on sidebar (thanks to abadc0de)
2013-11-27 09:50:38 +02:00
8081e5b43c
option to use Markdown titles instead of file names with 'use_markdown_titles' (otherwise drop the .md extension on display)
2013-11-18 10:26:40 +02:00
9fc5697cff
Issue #108 : sorting modules etc is off by default, switch back on using 'sort_modules=true'. Section lookup in docs was borked, fixed by stripping any extra whitespace before section titles
2013-11-17 10:38:24 +02:00
4666e464cc
no more fooling with globals in LDoc; the class ModuleMap is no longer global, but inserted into doc module so it can use it
2013-11-16 21:03:43 +02:00
fd323aa286
Issue #105 ; can switch off auto-linking to Lua manual with 'no_lua_ref' variable. This also happens if plain C documentation is being generated
2013-11-16 20:36:53 +02:00
d2e40e2f2f
basic support for documenting C. If you put 'parse_extra={C=true}' in config.ld, then it will attempt to extract function name, arguments and types from the source
2013-09-20 13:33:06 +02:00
df72613e57
structure return needs 'typename'; by default merge_error_groups will combine different error tag texts
2013-08-27 12:47:47 +02:00
0d79e16706
PL utils.unpack compatibility; refactoring error 'tag'
2013-08-26 09:59:10 +02:00
7da46268dc
'pale' template added; interpretation of --style and --template extended
2013-08-25 19:38:01 +02:00
ad909d683b
Can prettify C files as well as Lua with built-in prettifier
2013-08-25 14:29:30 +02:00
45cb21bcc1
try harder with -m to resolve methods
2013-08-24 15:39:41 +02:00
3c72ea112e
ldoc.alias can specify a function which must return tag, value, modifiers like Item:check_tag. The alias error works with return groups
2013-08-24 15:19:45 +02:00
9af4bae066
return groups; experimental 'error' tag
2013-08-24 13:21:41 +02:00
70eaf2be6f
bumped to 1.4.0; doc updates and formatting
2013-08-23 13:50:34 +02:00
3c72e9e4d1
fix issue #80 , backticks expand in copyright and other 'info' tags. format='backtick' (-f backtick) is like format='plain' but with implicit 'backtick_references=true'. -X is short for 'not_luadoc'
2013-08-22 09:43:26 +02:00
dfdac3f977
fix #84 ; also no_space_before_args=false to stop ldoc putting space between name and arglist of functions
2013-08-20 15:26:49 +02:00
52e9b6f32c
new classmod tag for defining modules that just export one class (experimental)
2013-08-07 15:19:46 +02:00
94dc198f4b
support for generating Markdown; basic support for Moonscript
2013-08-05 19:27:42 +02:00
adcd9c5ede
better soln for issue #73 : partial sorting for all processed files
2013-08-02 14:18:41 +02:00
7fe6a95544
a partial solution for issue #73 : ldoc.module_file to pick master modules when present
2013-08-01 12:14:57 +02:00
8a071fb517
issue #64 : use 'sort=true' in config.ld to sort items in sections
2013-07-31 14:25:33 +02:00
eb00a499b2
finally fixed issue #32 (sorry Eric). Can now dump non-modules like scripts
2013-07-23 10:40:07 +02:00
ff2e5ccaed
Default output directory is now 'doc'; annotations were borked and not_luadoc check could blow up
2013-05-15 15:30:47 +02:00
cf7b8e3a9a
fixes issue #62 : keep LuaDoc compatibility, unless not_luadoc is explicitly set
2013-05-09 13:28:39 +02:00
ac5c5f2c65
'plain=true' when format is set but you do not want doc comments treated specially. Backticks are now expanded in usage blocks
2013-05-09 12:52:15 +02:00
97af82c53d
bumped to 1.3.11
2013-04-13 16:15:54 +02:00
42429e694c
file={'.'} in config.d caused module name failure; docs->doc
2013-04-13 15:44:27 +02:00
6d22818ec9
allow -c to be used with explicit file
2013-04-11 15:37:01 +02:00
97538e33b9
bump to 1.3.10
2013-03-28 13:36:46 +02:00
619d8e1710
-O for one col layout, -S for simple (no params,ret or summary); one col switches off function list. Bumped to 1.3.8
2013-03-28 13:28:05 +02:00
158aa9ff14
can override utf-8 with either 'charset=<cs>' or per-module with @charset <cs>
2013-03-27 15:50:37 +02:00
d176dedcfc
bump version to 1.3.8 in usage; ignore empty docstrings (Dirk bug)
2013-03-26 11:53:42 +02:00
8856f09629
pretty field can be set to 'lxsh'; github-flavoured Markdown fenced code blocks; if lxsh, can also highlight c, sh and bib
2013-03-06 17:07:28 +02:00
afedf3fe4b
Add Objective-C++ extension to supported file types
2013-03-04 14:34:34 +01:00
1b67b1cd6f
wrap=true in config.ld will switch off nowrap in name column of function tables
2013-02-13 14:44:33 +02:00
394ba636bc
link fix in docs and anti-global jihad
2013-02-13 14:15:29 +02:00
55bbeed4f4
added module merging - see tests/merge directory (--merge flag)
2013-01-28 11:23:31 +02:00
10b5819667
new_type() can now specify subfield; Colon mode must be explicitly switched on with -C,--colon or in config.ld
2013-01-25 09:09:40 +02:00
5e87bcf400
serious .0 bug squashed! nocolon option to turn off colon-style detection. boilerplate option forces first comments to be ignored
2013-01-02 13:04:14 +02:00
9021b144b8
usage is now explicitly a multiline tag, so it is not considered part of the description. We are now ignoring Lua comments like so --- some text --- since they're commonly used to indicate logical sections - not for export
2012-12-31 17:02:40 +02:00
88d9ee4e8b
--define lets you set conditional flags for config.ld; single module detection improved
2012-12-29 12:01:40 +02:00
f4b164f24f
added --ignore flag (can be in config) to prevent LD from complaining about files with no docs. @submodule implemented
2012-12-10 14:45:54 +02:00
b91adaabc8
cannot use function and table as tparam aliases, because they conflict with existing tag types. So (for now) func and tab..
2012-11-08 19:38:30 +02:00
53ed04c08d
added standard tparam aliases and a test target
2012-11-07 18:42:16 +02:00
53166f626f
Added a comple of missing requires
2012-10-29 13:14:54 +13:00
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
Hisham Muhammad
Mooffie
abadc0de
Steve Donovan
Andrej Mihajlov
Geoff Leyland
Nils Nordman