Steve Donovan
7e2e6e975c
Issue #96 : was expecting a space after ## in markdown documents; better support for C types
2013-09-27 15:37:46 +02:00
Steve Donovan
7a7865f300
Issue 95: strip leading stars in C block comments; improvements in identifying typenames within type expressions
2013-09-26 16:05:45 +02:00
Steve Donovan
531a7d34de
Issue 81 'example' tag raises more explicit error, exclude more 'accidental' doc comments
2013-09-26 15:34:53 +02:00
Steve Donovan
1d1ed6d0f0
on left-hand side all module names go through doc.module_name. This strips off package part currently
2013-08-27 13:17:11 +02:00
Steve Donovan
df72613e57
structure return needs 'typename'; by default merge_error_groups will combine different error tag texts
2013-08-27 12:47:47 +02:00
steve donovan
85dbd3d731
no-compat 5.2/5.3 compatible; line endings for markdown.lua
2013-08-25 21:01:30 +02:00
Steve Donovan
d9d749fa37
fix issue #79 : will not allow a module as a type. Plus, add reference lookup for lfs and lpeg
2013-08-21 14:52:09 +02:00
Steve Donovan
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
Steve Donovan
52e9b6f32c
new classmod tag for defining modules that just export one class (experimental)
2013-08-07 15:19:46 +02:00
steve donovan
94dc198f4b
support for generating Markdown; basic support for Moonscript
2013-08-05 19:27:42 +02:00
Steve Donovan
7fe6a95544
a partial solution for issue #73 : ldoc.module_file to pick master modules when present
2013-08-01 12:14:57 +02:00
Steve Donovan
8a071fb517
issue #64 : use 'sort=true' in config.ld to sort items in sections
2013-07-31 14:25:33 +02:00
steve donovan
35a391d7d7
set tag in module can be used to set rendering properties etc of an individual module, e.g 'set no_return_or_parms=true'
2013-07-18 10:12:25 +02:00
steve donovan
0ee96935a3
charset functionality was borked in general case
2013-04-03 12:20:54 +02:00
steve donovan
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
steve donovan
897061ac17
squashed trailing space problem with section titles; allowing numbers in links
2013-03-28 13:06:42 +02:00
steve donovan
158aa9ff14
can override utf-8 with either 'charset=<cs>' or per-module with @charset <cs>
2013-03-27 15:50:37 +02:00
steve donovan
a7b01abd03
module at-references now working! No-contents warning fixed
2013-03-23 17:51:55 +02:00
steve donovan
4bc48dafc3
modules returning a single function are supported, see tests/styles/func.lua. Parameters may have subfields, see tests/styles/subparams.lua
2013-03-18 15:51:28 +02:00
steve donovan
496b534ce1
@type summary no longer dropped ( #49 ); @type can be used with @usage ( #52 ); CSS tweaks for prettification; nasty '<pre/>' typo squashed
2013-03-07 13:09:48 +02:00
steve donovan
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
steve donovan
7ceb7cc00b
@usage code blocks are prettified
2013-03-05 16:21:54 +02:00
steve donovan
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
steve donovan
1bb83924bb
in implicit function style (a la Geoff) the first comment refers to the return value. In colon style, an exclamation mark allows a typename to be directly used as a 'tag'. The word 'optional' is only issued if we have either nil or a type
2012-12-31 14:52:00 +02:00
steve donovan
754da6e8d8
usage strings were not HTML-escaped properly (Eric)
2012-12-13 19:18:24 +02:00
steve donovan
a551b47085
fallback for type macros in tables (starting). Use label suggested by custom lookup for type names
2012-12-13 15:01:33 +02:00
Geoff Leyland
2b304a2252
Use classes for formatting argument descriptions rather than tags
2012-10-29 13:26:07 +13:00
Geoff Leyland
9924e4dced
Parse type expressions like '?table|string' and turn them into 'optional table or string'
2012-10-29 13:24:49 +13:00
steve donovan
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
steve donovan
f474eccdf8
factory-style classes: see tests/factory.lua
2012-08-22 12:50:57 +02:00
Alexander V. Nikolaev
78ffa7e651
Strip trailing whitespaces from output
2012-08-06 16:52:27 +00:00
steve donovan
967dd60139
revamping docs; kind sort order in documents
2012-03-15 15:06:30 +02:00
steve donovan
c0d7c6d0ac
clearer messages when switching to another directory
2011-12-12 13:15:04 +02:00
steve donovan
70e1f22909
tparam/treturn aliases for type modifiers: display of types with standard template
2011-12-06 19:19:09 +02:00
steve donovan
746eecc979
doc updates: @plain for switching off code block prettification
2011-09-20 15:59:34 +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
74531d7106
presenting Lua methods as Class:name in a @type
2011-09-11 19:17:05 +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
1dc062dafb
extending code inferrence patterns
2011-07-29 15:53:45 +02:00
steve donovan
0b181d3b66
ldoc.output was not set before the index
2011-07-14 15:27:16 +02:00
steve donovan
a41792c56c
better support for one-column style
2011-07-12 15:42:58 +02:00
steve donovan
aae0c9a5d1
great refactoring: now also prettifies code in Markdown documents
2011-07-12 14:14:55 +02:00