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
|
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
|
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
|
149ded81fc
|
composite return types experiment
|
2013-08-25 10:47:45 +02:00 |
|
steve donovan
|
45cb21bcc1
|
try harder with -m to resolve methods
|
2013-08-24 15:39:41 +02:00 |
|
steve donovan
|
3c72ea112e
|
ldoc.alias can specify a function which must return tag, value, modifiers like Item:check_tag. The alias error works with return groups
|
2013-08-24 15:19:45 +02:00 |
|
steve donovan
|
9af4bae066
|
return groups; experimental 'error' tag
|
2013-08-24 13:21:41 +02:00 |
|
Steve Donovan
|
70eaf2be6f
|
bumped to 1.4.0; doc updates and formatting
|
2013-08-23 13:50:34 +02:00 |
|
Steve Donovan
|
7bb95e5e7d
|
issue #78 default parm value now in documentation
|
2013-08-22 10:12:04 +02:00 |
|
Steve Donovan
|
a162c4b9e9
|
a list of comma-separated items can appear after a see tag; fixed problem with references to Lua global functions from last commit
|
2013-08-21 15:52:53 +02:00 |
|
Steve Donovan
|
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 |
|
Steve Donovan
|
dfdac3f977
|
fix #84; also no_space_before_args=false to stop ldoc putting space between name and arglist of functions
|
2013-08-20 15:26:49 +02:00 |
|
Steve Donovan
|
80a109e022
|
issue #66: better error message for non-luadoc behaviour; now controlling backticks in the docs better
|
2013-08-20 14:57:41 +02:00 |
|
Steve Donovan
|
52e9b6f32c
|
new classmod tag for defining modules that just export one class (experimental)
|
2013-08-07 15:19:46 +02:00 |
|
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 |