9f314ea7fc
documentation overhaul
2012-03-16 14:41:26 +02:00
967dd60139
revamping docs; kind sort order in documents
2012-03-15 15:06:30 +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
87f48c91d3
can now make references to sections (in their underscored form); parser will quietly bail out on empty files
2012-03-13 12:23:55 +02:00
9d0d12c31a
refs to Lua 5.2 docs (if we are using 5.2) and bumped up major version to 1.2
2012-03-13 10:37:07 +02:00
20ddca927d
added classes.lua to config.ld example in tests/
2012-03-06 10:41:19 +02:00
536ee894d2
do not prepend class qualifier (Fred:) if the name already contains it
2012-03-06 10:39:33 +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
de7fef1c45
creating an alias for a tparam TYPE tags
2012-03-04 18:57:17 +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
6c3c19f3bf
ldoc.readme can be multiple; ldoc.topics is a synonym.
2012-03-04 18:42:50 +02:00
38c8f187b3
improved varargs support; updated example to show this and tparam usage
2012-03-02 13:19:34 +02:00
ecd6b4cfa5
changes to varargs matching
2012-03-01 20:08:55 +02:00
c8f556804e
Merge branch 'master' of github.com:stevedonovan/LDoc
2012-02-29 19:21:40 +02:00
edd4a6b35e
Lua 5.2 compatibility changes - now working fine so far
2012-02-29 19:20:57 +02:00
a811dfa5f4
Merge branch 'master' of github.com:stevedonovan/LDoc
2012-01-09 15:12:53 +02:00
725e49f50e
malformed ref check did not allow - (in example file names)
2012-01-09 14:07:24 +02:00
5422edcffe
1.1.0 beta push
2011-12-21 15:04:16 +02:00
444a3d9ce3
directory clean out
2011-12-17 17:08:00 +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
c0d7c6d0ac
clearer messages when switching to another directory
2011-12-12 13:15:04 +02:00
dcd62ffa9d
doc updates; problem with @usage with scripts; formal arguments now always take precendence; warnings cleaned up
2011-12-09 15:43:37 +02:00
69a952b76b
fallback troubleshooting code for now
2011-12-06 19:20:17 +02:00
70e1f22909
tparam/treturn aliases for type modifiers: display of types with standard template
2011-12-06 19:19:09 +02:00
3d8cdadc88
tried to access modifiers when not present
2011-10-04 15:54:08 +02:00
50b4e733eb
new Penlight puts Lua 5.2-style load in utils table; now checking for this case, preserving compatibility
2011-10-04 15:37:14 +02:00
0d1c4d1514
generic support for tag modifiers; modifiers "opt" and "optchain" for tag "param"
2011-10-04 14:54:08 +02:00
d55323812f
doc typos
2011-09-26 12:47:13 +02:00
88326dc668
update builtin luadoc; tweaks to template
2011-09-22 15:48:09 +02:00
fbbdba7ecf
documenting customizing options; problem with no_summary fixed
2011-09-21 15:50:11 +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
1dd35e86a0
great renaming: moved everything into ldoc module tree
2011-09-20 12:59:34 +02:00
c694526232
updating docs
2011-09-20 12:53:31 +02:00
a606f6305e
cleaned up some runaway table field detection code, which caused crashes with table items with no declared fields
2011-09-19 19:23:53 +02:00
86dd93e67c
prepare ldoc.lua for self-documentation
2011-09-19 15:53:43 +02:00
6e941f576f
support for -- @usage shortcut
2011-09-19 15:53:00 +02:00
8ad081317e
manual_url _function_ in config.ld can specify another location for the Lua manual file:///D:/dev/lua/projects/lua-5.1.4/doc/manual.html
2011-09-19 14:42:54 +02:00
1a2e61a1f9
prettifying code in readme
2011-09-19 14:22:18 +02:00
40330487b0
@usage tag now works in module comments; annotations were borked
2011-09-19 13:34:01 +02:00
2b54ad1627
mark global functions and tables when prettifying code
2011-09-19 13:32:30 +02:00
88b9a97cb1
building ldoc documentation
2011-09-18 20:45:55 +02:00
dd881ddcf2
annotations have reference to main parent item
2011-09-18 20:45:36 +02:00
f5c11dcdf5
support for annotations: an item containing one of fixme, todo or warning can appear anywhere in code
2011-09-17 19:13:47 +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
74531d7106
presenting Lua methods as Class:name in a @type
2011-09-11 19:17:05 +02:00
a177ceaa59
doc updates
2011-09-11 19:16:00 +02:00
7be49eace7
errors in config file now cause message & quit
2011-09-11 17:47:34 +02:00
a418859589
updating documentation
2011-09-01 16:00:16 +02:00
steve donovan
Fabien