b16e85af7d
Fix issue #123 : override 'boilerplate' was done too late
2013-12-24 11:30:56 +01:00
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
Dirk Feytons
Hisham Muhammad
Mooffie
abadc0de
Steve Donovan
Andrej Mihajlov
Geoff Leyland