Steve Donovan
5dd69b90bf
support for Moonscript fat vs thin arrows; tools.get_parameters also returns last token found; lang.method_call generalization
2013-08-07 11:05:55 +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
eb00a499b2
finally fixed issue #32 (sorry Eric). Can now dump non-modules like scripts
2013-07-23 10:40:07 +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
624cf7d742
issue #70 crash
2013-06-06 18:59:11 +02:00
steve donovan
4208b21234
issue #65 ; see references no longer have multiple option, but can now allow custom formats
2013-05-27 14:47:26 +02:00
steve donovan
2bd2b23d7d
topics are added with nil description
2013-05-27 10:47:55 +02:00
steve donovan
ff2e5ccaed
Default output directory is now 'doc'; annotations were borked and not_luadoc check could blow up
2013-05-15 15:30:47 +02:00
steve donovan
cf7b8e3a9a
fixes issue #62 : keep LuaDoc compatibility, unless not_luadoc is explicitly set
2013-05-09 13:28:39 +02:00
steve donovan
123099ca07
if we find a shared master module, close its section before using it. Appears to fix issue #56
2013-05-06 11:52:36 +02:00
steve donovan
a3cb09c098
Issue #61 sorted - not using Tags.add consistently
2013-05-06 11:38:20 +02:00
steve donovan
68cd576bf4
module deduction can blow up; UTF BOM ignored
2013-04-16 10:11: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
0706681e72
using parameters which were List method names caused chaos
2013-03-25 10:12:20 +02:00
steve donovan
a8ea31b01d
fixed opt bug and weird issue when section title clashes with standard section names
2013-03-21 19:52:53 +02:00
steve donovan
741cba8ff2
merging trailing [opt] as [optchain]s. Trying to solve 'self' references in modules
2013-03-20 14:41:54 +02:00
steve donovan
65723a9dc4
issue #57 : [opt=default] support - see tests/styles/four.lua
2013-03-19 15:00:57 +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
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
steve donovan
dee7cd200a
fixed issue #47 ; flag-style tags like @local were blowing up with description collection
2013-03-07 13:49:39 +02:00
steve donovan
d7ee2d806f
no longer an error for @function to have modifiers ( #45 ), although we're not yet passing it through. New @static tag for class methods
2013-03-07 13:39:41 +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
95f293e67e
ordinary non 'method' functions of a 'class' must be respected, and not prefixed with class:
2013-03-05 17:56:30 +02:00
steve donovan
394ba636bc
link fix in docs and anti-global jihad
2013-02-13 14:15:29 +02:00
steve donovan
55bbeed4f4
added module merging - see tests/merge directory (--merge flag)
2013-01-28 11:23:31 +02:00
steve donovan
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
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
a3aa4dc979
within tag working; allow description to appear after some tags (needed tags as ordered maps for this)
2012-12-29 12:04:39 +02:00
steve donovan
4801a6ba10
export tag gives warnings if an item has not been documented
2012-12-22 16:29:42 +02:00
steve donovan
d51a8d63c9
tables may now have _any_ mix of field and param tags. Fixes hack to permit type macros in table definitions
2012-12-21 19:13:40 +02:00
steve donovan
f54e13185e
tag modifier code not respecting boolean types; export tag now properly makes local functions module-scope
2012-12-21 18:25:06 +02:00
steve donovan
8869cf4924
tparam macros can be used in table definitions
2012-12-13 19:17:32 +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
steve donovan
f4b164f24f
added --ignore flag (can be in config) to prevent LD from complaining about files with no docs. @submodule implemented
2012-12-10 14:45:54 +02:00
Geoff Leyland
a2a3da455e
Remove requirement to have more than one formal argument when using comments on the arguments. I'm not sure what that was for, so I might have broken something
2012-10-29 13:17:44 +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
Steve J Donovan
04c6922eeb
custom see references; Lua 5.2 issue sorted
2012-07-30 12:36:28 -04:00
steve donovan
578f4da1cf
now working with PL strict mode...
2012-03-23 14:21:43 +02:00
steve donovan
27fcd4d5fc
Do not resolve references when using -m. Can now use @treturn just with a type (pattern fix). Default dump more structured.
2012-03-17 12:17:22 +02:00
steve donovan
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
steve donovan
536ee894d2
do not prepend class qualifier (Fred:) if the name already contains it
2012-03-06 10:39:33 +02:00
steve donovan
38c8f187b3
improved varargs support; updated example to show this and tparam usage
2012-03-02 13:19:34 +02:00
steve donovan
ecd6b4cfa5
changes to varargs matching
2012-03-01 20:08:55 +02:00
steve donovan
725e49f50e
malformed ref check did not allow - (in example file names)
2012-01-09 14:07:24 +02:00
steve donovan
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
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
3d8cdadc88
tried to access modifiers when not present
2011-10-04 15:54:08 +02:00
Fabien
0d1c4d1514
generic support for tag modifiers; modifiers "opt" and "optchain" for tag "param"
2011-10-04 14:54:08 +02:00