steve donovan
|
04dc148df6
|
Issue #145: do not expand annotations if there's no previous item
|
2014-01-06 15:03:09 +02:00 |
|
steve donovan
|
60c6e79dd9
|
Issue #137 boilerplate Lua block comment
|
2014-01-06 13:35:12 +02:00 |
|
steve donovan
|
86a3fde07e
|
issue #139; improved lookup for class methods; args override now only kicks if the argument does not have its default value
|
2014-01-05 14:55:20 +02:00 |
|
steve donovan
|
f507e36720
|
more general method of controlling visibility of local functions or items marked with @local
|
2014-01-02 18:45:04 +02:00 |
Hisham Muhammad
|
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 |
Mooffie
|
67a78ee0a5
|
Fix minor issues with the "prettify" facility.
|
2013-12-12 18:04:16 +02:00 |
|
Steve Donovan
|
f60e6d4197
|
Pull #121 applied manually - custom tags may be hidden
|
2013-12-09 15:13:00 +02:00 |
|
Mooffie
|
3053079fee
|
Custom display_name handler.
|
2013-12-09 12:23:27 +02:00 |
abadc0de
|
89854e1537
|
Custom tags
Custom tags
|
2013-11-28 10:46:59 -05:00 |
|
Steve Donovan
|
4294b2e2da
|
Issue #114: trying harder to resolve references by unqualified method name
|
2013-11-28 11:57:13 +02:00 |
|
Steve Donovan
|
63e3618c05
|
Issue #110; use '-u' or 'unqualified' explicitly to strip package names on sidebar (thanks to abadc0de)
|
2013-11-27 09:50:38 +02:00 |
|
Steve Donovan
|
46515b2411
|
Issue #113, borked classmod: now custom sections are always respected. Automatic sections are generated for 'Metamethods' and 'Methods'
|
2013-11-27 09:46:37 +02:00 |
|
Steve Donovan
|
4fac99406c
|
try match single names against fully qualified names of module funtions
|
2013-11-21 16:06:34 +02:00 |
|
Steve Donovan
|
feabf5c91a
|
when using export tag, decide whether function is meant to be a class method from 'self' formal arg, otherwise it becomes static.
|
2013-11-18 14:54:28 +02:00 |
|
Steve Donovan
|
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 |
|
steve donovan
|
9ef1f08784
|
can resolve references to local class; no longer have 'Topic: ' for readme documents
|
2013-11-17 19:48:35 +02:00 |
|
steve donovan
|
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 |
|
steve donovan
|
4666e464cc
|
no more fooling with globals in LDoc; the class ModuleMap is no longer global, but inserted into doc module so it can use it
|
2013-11-16 21:03:43 +02:00 |
|
steve donovan
|
fd323aa286
|
Issue #105; can switch off auto-linking to Lua manual with 'no_lua_ref' variable. This also happens if plain C documentation is being generated
|
2013-11-16 20:36:53 +02:00 |
|
steve donovan
|
955802e07b
|
Issue #93: can define fields/properties of objects; the 'readonly' modifier is now special. See tests/styles/type.lua
|
2013-11-16 19:21:50 +02:00 |
|
Steve Donovan
|
7e2e6e975c
|
Issue #96: was expecting a space after ## in markdown documents; better support for C types
|
2013-09-27 15:37:46 +02:00 |
|
Steve Donovan
|
7a7865f300
|
Issue 95: strip leading stars in C block comments; improvements in identifying typenames within type expressions
|
2013-09-26 16:05:45 +02:00 |
|
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
|
47e6a2094e
|
CSS errors fixed
|
2013-08-27 15:16:10 +02:00 |
|
Steve Donovan
|
8e3e211716
|
fixup selected module item
|
2013-08-27 14:16:21 +02:00 |
|
Steve Donovan
|
1d1ed6d0f0
|
on left-hand side all module names go through doc.module_name. This strips off package part currently
|
2013-08-27 13:17:11 +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
|
f33a09e4d3
|
issue #76 auto-scroll to avoid breaking identifiers
|
2013-08-27 12:44:04 +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
|
85dbd3d731
|
no-compat 5.2/5.3 compatible; line endings for markdown.lua
|
2013-08-25 21:01:30 +02:00 |
|
steve donovan
|
7da46268dc
|
'pale' template added; interpretation of --style and --template extended
|
2013-08-25 19:38:01 +02:00 |
|
steve donovan
|
ad909d683b
|
Can prettify C files as well as Lua with built-in prettifier
|
2013-08-25 14:29:30 +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
|
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 |
|
Steve Donovan
|
5e18d2ad4c
|
check builtin references. Builtin files are now all requireable (without module)
|
2013-08-22 09:15:16 +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
|
5699d002ef
|
issue #77: 'See also' in template
|
2013-08-20 14:59:13 +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
|
3e78c4704b
|
partial file list sorting refactor was borked
|
2013-08-07 13:33:38 +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
|
b87180996d
|
Moonscript: support for modules using with statement; optionally ignore colon as part of an identifier
|
2013-08-07 09:53:39 +02:00 |
|
steve donovan
|
94dc198f4b
|
support for generating Markdown; basic support for Moonscript
|
2013-08-05 19:27:42 +02:00 |
|
Steve Donovan
|
adcd9c5ede
|
better soln for issue #73: partial sorting for all processed files
|
2013-08-02 14:18:41 +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
|
8a071fb517
|
issue #64: use 'sort=true' in config.ld to sort items in sections
|
2013-07-31 14:25:33 +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
|
16981eeb3e
|
Merge branch 'master' of github.com:stevedonovan/LDoc
|
2013-07-22 13:30:04 +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
|
320dfed2e3
|
no longer any need for setfenv in markdown.lua
|
2013-06-14 15:19:51 +02:00 |
|
steve donovan
|
624cf7d742
|
issue #70 crash
|
2013-06-06 18:59:11 +02:00 |
Ignas Anikevicius
|
7e766f9aaa
|
Fix markdown.lua to work with LUA 5.2
The `setfenv` variable is unavailable in LUA 5.2, so call it conditionally.
|
2013-06-02 17:25:20 +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
|
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 |
|
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
|
5beb1f048a
|
Merge branch 'master' of github.com:stevedonovan/LDoc
|
2013-04-17 12:08:44 +02:00 |
|
steve donovan
|
167a4595a5
|
built-in markdown crack down on locals; still very slow
|
2013-04-17 12:08:11 +02:00 |
|
steve donovan
|
68cd576bf4
|
module deduction can blow up; UTF BOM ignored
|
2013-04-16 10:11:05 +02:00 |
|
steve donovan
|
97af82c53d
|
bumped to 1.3.11
|
2013-04-13 16:15:54 +02:00 |
|
steve donovan
|
0ee96935a3
|
charset functionality was borked in general case
|
2013-04-03 12:20:54 +02:00 |
|
steve donovan
|
619d8e1710
|
-O for one col layout, -S for simple (no params,ret or summary); one col switches off function list. Bumped to 1.3.8
|
2013-03-28 13:28: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
|
d176dedcfc
|
bump version to 1.3.8 in usage; ignore empty docstrings (Dirk bug)
|
2013-03-26 11:53:42 +02:00 |
|
steve donovan
|
0706681e72
|
using parameters which were List method names caused chaos
|
2013-03-25 10:12:20 +02:00 |
|
steve donovan
|
a7b01abd03
|
module at-references now working! No-contents warning fixed
|
2013-03-23 17:51:55 +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
|
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 |
|
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
|
357ee3978d
|
don't strip multiline tag values. Allows multiline @usage blocks to work nicely
|
2013-03-05 17:00:33 +02:00 |
|
steve donovan
|
7ceb7cc00b
|
@usage code blocks are prettified
|
2013-03-05 16:21:54 +02:00 |
|
steve donovan
|
1b67b1cd6f
|
wrap=true in config.ld will switch off nowrap in name column of function tables
|
2013-02-13 14:44:33 +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
|
10b5819667
|
new_type() can now specify subfield; Colon mode must be explicitly switched on with -C,--colon or in config.ld
|
2013-01-25 09:09:40 +02:00 |
|
steve donovan
|
5e87bcf400
|
serious .0 bug squashed! nocolon option to turn off colon-style detection. boilerplate option forces first comments to be ignored
|
2013-01-02 13:04:14 +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
|
c49fa67644
|
more tests; styles meant as catalog of supported styles, submodule shows off within and submodule tag
|
2012-12-29 12:09:34 +02:00 |