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
80e2e1e112
lorenzo's suggestion; may optionally provide text for the reference link using a colon
2011-08-21 17:25:28 +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
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
4d718d3e86
Inline references are now @{ref}, not <ref>
2011-07-07 14:29:27 +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
99cfca7643
attempt to tame markdown.lua's need for blank lines around lists; it is not doing nested lists correctly (throwing in <p> inside <li>)
2011-07-05 18:53:28 +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
steve donovan