Steve Donovan
160eda087e
Merge branch 'master' of github.com:stevedonovan/LDoc
2014-06-27 15:55:12 +02:00
Steve Donovan
9a5b556a2d
summary/description with type/section fixed
2014-06-27 15:50:21 +02:00
steve donovan
9bd5dd0ec7
dont_escape_underscore defaults to true if markdown.lua is not used; global_lookup defaults to true if parse_extra.C
2014-06-22 17:14:08 +02:00
Steve Donovan
acc6ed2ad3
prettify code blocks in module docstring. Two new ldoc flags: dont_escape_underscore (when not using markdown.lua) and global_lookup (when specifically wanting global lookup for single symbols
2014-06-20 15:11:40 +02:00
Steve Donovan
a0c780f093
allow Markdown headers in module docstring by stripping #..
2014-06-20 15:09:38 +02:00
steve donovan
bf0f1384b9
Updated pale theme
2014-05-26 17:58:43 +02:00
steve donovan
3f32313ced
#158 summary line lost with @type tag
2014-05-25 13:58:25 +02:00
Steve Donovan
6d29aef7f2
allow tags to contain digits
2014-04-25 15:59:54 +02:00
Steve Donovan
1f21b5efa3
workaround for Lua file methods #157
2014-04-23 13:38:58 +02:00
Steve Donovan
624ff11afd
parameter names which were List methods overwriting object - factor out as map field
2014-04-23 13:19:16 +02:00
Steve Donovan
251dc88f93
deterministic ordered file processing
2014-04-23 10:20:55 +02:00
steve donovan
511dfe7df0
ldoc.custom_references to create new @{KIND:NAME} reference schemes; doc updates
2014-01-21 19:51:55 +02:00
Steve Donovan
2c0d459a43
bumped version to 1.4.2
2014-01-16 09:53:29 +02:00
Gary V. Vaughan
fc0e6099fa
html: case sensitive file systems require matching require args.
...
* ldoc/html.lua: Make sure to `require 'pl.OrderedMap'` (with a
capital 'O') to match the filename installed by penlight.
Signed-off-by: Gary V. Vaughan <gary@gnu.org>
2014-01-08 16:55:32 +13:00
steve donovan
d367390c68
Issue #150 : 'info' section ordering is now consistent
2014-01-07 17:48:50 +02:00
Steve J Donovan
a8c4d9fa1e
Merge pull request #149 from vanzomerenc/master
...
Resolve issue #22 'In-line links with underscores are broken'
2014-01-07 01:19:37 -08:00
vanzomerenc
7c49337402
Resolve issue #22 'In-line links with underscores are broken'
2014-01-06 16:10:12 -05:00
steve donovan
04dc148df6
Issue #145 : do not expand annotations if there's no previous item
2014-01-06 15:03:09 +02:00
steve donovan
60c6e79dd9
Issue #137 boilerplate Lua block comment
2014-01-06 13:35:12 +02:00
steve donovan
86a3fde07e
issue #139 ; improved lookup for class methods; args override now only kicks if the argument does not have its default value
2014-01-05 14:55:20 +02:00
steve donovan
f507e36720
more general method of controlling visibility of local functions or items marked with @local
2014-01-02 18:45:04 +02:00
Hisham Muhammad
8b48e1d256
Don't call function when missing. Tweak needed for ldoc to build its own documentation files.
2013-12-21 00:50:07 -02:00
Mooffie
67a78ee0a5
Fix minor issues with the "prettify" facility.
2013-12-12 18:04:16 +02:00
Steve Donovan
f60e6d4197
Pull #121 applied manually - custom tags may be hidden
2013-12-09 15:13:00 +02:00
Mooffie
3053079fee
Custom display_name handler.
2013-12-09 12:23:27 +02:00
abadc0de
89854e1537
Custom tags
...
Custom tags
2013-11-28 10:46:59 -05:00
Steve Donovan
4294b2e2da
Issue #114 : trying harder to resolve references by unqualified method name
2013-11-28 11:57:13 +02:00
Steve Donovan
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
Steve Donovan
46515b2411
Issue #113 , borked classmod: now custom sections are always respected. Automatic sections are generated for 'Metamethods' and 'Methods'
2013-11-27 09:46:37 +02:00
Steve Donovan
4fac99406c
try match single names against fully qualified names of module funtions
2013-11-21 16:06:34 +02:00
Steve Donovan
feabf5c91a
when using export tag, decide whether function is meant to be a class method from 'self' formal arg, otherwise it becomes static.
2013-11-18 14:54:28 +02:00
Steve Donovan
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
steve donovan
9ef1f08784
can resolve references to local class; no longer have 'Topic: ' for readme documents
2013-11-17 19:48:35 +02:00
steve donovan
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
steve donovan
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
steve donovan
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
steve donovan
955802e07b
Issue #93 : can define fields/properties of objects; the 'readonly' modifier is now special. See tests/styles/type.lua
2013-11-16 19:21:50 +02:00
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
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
Steve Donovan
47e6a2094e
CSS errors fixed
2013-08-27 15:16:10 +02:00
Steve Donovan
8e3e211716
fixup selected module item
2013-08-27 14:16:21 +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
f33a09e4d3
issue #76 auto-scroll to avoid breaking identifiers
2013-08-27 12:44:04 +02:00
Steve Donovan
8395d6d9d7
inline error comments starting to work
2013-08-26 14:22:52 +02:00
Steve Donovan
a825a316a1
error tag now auto-groups; refactorings
2013-08-26 13:37:41 +02:00
Steve Donovan
0d79e16706
PL utils.unpack compatibility; refactoring error 'tag'
2013-08-26 09:59:10 +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