f979400edb
chore: Add lint ignore overrides for warnings that get a pass
...
Mostly because refactoring these is hard, double negatives are much
harder to follow logic wise and there isn't much point in refactoring
these loops unless they need other work.
2020-10-02 01:06:18 +03:00
a3e8db19de
fix: Fix bug in error handler, io.exit()→os.exit()
2020-10-02 01:06:18 +03:00
92a6714d9a
refactor: Drop completely unused variable references
2020-10-02 01:06:18 +03:00
77e72bf92a
Support the use of commonmark markdown via cmark-lua ( #311 )
2020-09-29 23:59:43 +03:00
f97850dee6
Fix typo ( #325 )
2020-09-29 22:36:30 +03:00
d47c0f89bf
Debian lua-discount package is _yet another Lua binding_ to libmarkdown2
2016-06-27 16:44:18 +02:00
c9b6483d6d
issue #240 blank line after comment at end of code block. Crash with fenced block at end of document fixed
2016-06-27 15:27:15 +02:00
f3e5a5a576
Windows line endings led to wrong section names in Markdown documents
2016-06-21 12:26:36 -04:00
bba78586d4
support both available flavors of ldoc
2016-04-20 20:10:10 +02:00
3313e78b44
Support used-defined keywords (in prettified code).
2014-12-15 10:05:50 +02:00
25fd0b6bed
escape <> for HTML; uniform 14em navbar; uppercase C
2014-11-01 16:45:08 +02:00
c516eebd12
version bump; underscore escaping fix for backticks; horrible workaround for deficiencies of C lexer
2014-10-25 12:01:48 +02:00
3117f6f791
fix for underscore escape when using markdown.lua; do not use in prettified code blocks
2014-10-15 18:48:39 +02:00
2639ddec9f
issue #172 spurious space; still cleaning out tab infestation
2014-10-13 19:38:11 +02:00
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
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
511dfe7df0
ldoc.custom_references to create new @{KIND:NAME} reference schemes; doc updates
2014-01-21 19:51:55 +02:00
7c49337402
Resolve issue #22 'In-line links with underscores are broken'
2014-01-06 16:10:12 -05:00
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
67a78ee0a5
Fix minor issues with the "prettify" facility.
2013-12-12 18:04:16 +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
7e2e6e975c
Issue #96 : was expecting a space after ## in markdown documents; better support for C types
2013-09-27 15:37:46 +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
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
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
741cba8ff2
merging trailing [opt] as [optchain]s. Trying to solve 'self' references in modules
2013-03-20 14:41:54 +02:00
717eac46e5
tables inside 'classes' are implicitly 'static'; respect blank lines even if not using markdown; fall back to bundled markdown.lua if not found elsewhere
2013-03-08 13:40:59 +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
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
b039ac1574
fix for last Geoff patch (was asleep)
2012-12-28 11:00:10 +02:00
0f68f97513
added support for Luamark (Geoff)
2012-12-28 10:56:43 +02: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
578f4da1cf
now working with PL strict mode...
2012-03-23 14:21:43 +02:00
9bf51e3294
@ lookup can now happen on main page, and we now have a LuaRocks-agnostic way of finding builtin references
2012-03-19 19:07:11 +02:00
5b4fc640de
@lookup must be first thing; allow for shebang in scripts
2012-03-16 14:42:58 +02:00
9f314ea7fc
documentation overhaul
2012-03-16 14:41:26 +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
cb7426005b
topics alias now ok; don't emit <code> with backtick-references; update types.lua example
2012-03-05 15:34:16 +02:00
3ed4e1f942
references in markdown-style backticks will be resolved, default true if using markdown. Set ldoc.backtick_references to be explicit.
2012-03-04 18:46:02 +02:00
461fe4b711
fixed typo, dammit
2011-12-13 14:16:03 +02:00
fb5f5f290c
allow fallback from discount format to markdown
2011-12-12 15:48:35 +02:00
69a952b76b
fallback troubleshooting code for now
2011-12-06 19:20:17 +02:00
746eecc979
doc updates: @plain for switching off code block prettification
2011-09-20 15:59:34 +02:00
4a0b997975
doc updates: escaping @{}
2011-09-20 14:11:31 +02:00
1a2e61a1f9
prettifying code in readme
2011-09-19 14:22:18 +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
2174f39191
Extended inline ref is now @{name|label}; colon gets confused with method operator
2011-08-25 19:02:06 +02:00
e680b44435
tweak to allowing space before :; do not strip linefeed after end of summary.
2011-08-21 18:50:58 +02:00
Caleb Maclennan
Alexei Robyn
Elliott Slaughter
Steve Donovan
Ingo Struck
Mooffie
vanzomerenc
Hisham Muhammad