60c6e79dd9
Issue #137 boilerplate Lua block comment
2014-01-06 13:35:12 +02:00
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
f507e36720
more general method of controlling visibility of local functions or items marked with @local
2014-01-02 18:45:04 +02:00
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
67a78ee0a5
Fix minor issues with the "prettify" facility.
2013-12-12 18:04:16 +02:00
f60e6d4197
Pull #121 applied manually - custom tags may be hidden
2013-12-09 15:13:00 +02:00
3053079fee
Custom display_name handler.
2013-12-09 12:23:27 +02:00
89854e1537
Custom tags
...
Custom tags
2013-11-28 10:46:59 -05:00
4294b2e2da
Issue #114 : trying harder to resolve references by unqualified method name
2013-11-28 11:57:13 +02:00
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
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
4fac99406c
try match single names against fully qualified names of module funtions
2013-11-21 16:06:34 +02:00
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
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
9ef1f08784
can resolve references to local class; no longer have 'Topic: ' for readme documents
2013-11-17 19:48:35 +02:00
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
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
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
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
7e2e6e975c
Issue #96 : was expecting a space after ## in markdown documents; better support for C types
2013-09-27 15:37:46 +02:00
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
531a7d34de
Issue 81 'example' tag raises more explicit error, exclude more 'accidental' doc comments
2013-09-26 15:34:53 +02:00
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
47e6a2094e
CSS errors fixed
2013-08-27 15:16:10 +02:00
8e3e211716
fixup selected module item
2013-08-27 14:16:21 +02:00
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
df72613e57
structure return needs 'typename'; by default merge_error_groups will combine different error tag texts
2013-08-27 12:47:47 +02:00
f33a09e4d3
issue #76 auto-scroll to avoid breaking identifiers
2013-08-27 12:44:04 +02:00
8395d6d9d7
inline error comments starting to work
2013-08-26 14:22:52 +02:00
a825a316a1
error tag now auto-groups; refactorings
2013-08-26 13:37:41 +02:00
0d79e16706
PL utils.unpack compatibility; refactoring error 'tag'
2013-08-26 09:59:10 +02:00
85dbd3d731
no-compat 5.2/5.3 compatible; line endings for markdown.lua
2013-08-25 21:01:30 +02:00
7da46268dc
'pale' template added; interpretation of --style and --template extended
2013-08-25 19:38:01 +02:00
ad909d683b
Can prettify C files as well as Lua with built-in prettifier
2013-08-25 14:29:30 +02:00
149ded81fc
composite return types experiment
2013-08-25 10:47:45 +02:00
45cb21bcc1
try harder with -m to resolve methods
2013-08-24 15:39:41 +02:00
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
9af4bae066
return groups; experimental 'error' tag
2013-08-24 13:21:41 +02:00
70eaf2be6f
bumped to 1.4.0; doc updates and formatting
2013-08-23 13:50:34 +02:00
7bb95e5e7d
issue #78 default parm value now in documentation
2013-08-22 10:12:04 +02:00
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
5e18d2ad4c
check builtin references. Builtin files are now all requireable (without module)
2013-08-22 09:15:16 +02:00
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
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
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
5699d002ef
issue #77 : 'See also' in template
2013-08-20 14:59:13 +02:00
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
52e9b6f32c
new classmod tag for defining modules that just export one class (experimental)
2013-08-07 15:19:46 +02:00
3e78c4704b
partial file list sorting refactor was borked
2013-08-07 13:33:38 +02:00
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
b87180996d
Moonscript: support for modules using with statement; optionally ignore colon as part of an identifier
2013-08-07 09:53:39 +02:00
94dc198f4b
support for generating Markdown; basic support for Moonscript
2013-08-05 19:27:42 +02:00
adcd9c5ede
better soln for issue #73 : partial sorting for all processed files
2013-08-02 14:18:41 +02:00
7fe6a95544
a partial solution for issue #73 : ldoc.module_file to pick master modules when present
2013-08-01 12:14:57 +02:00
8a071fb517
issue #64 : use 'sort=true' in config.ld to sort items in sections
2013-07-31 14:25:33 +02:00
eb00a499b2
finally fixed issue #32 (sorry Eric). Can now dump non-modules like scripts
2013-07-23 10:40:07 +02:00
16981eeb3e
Merge branch 'master' of github.com:stevedonovan/LDoc
2013-07-22 13:30:04 +02:00
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
320dfed2e3
no longer any need for setfenv in markdown.lua
2013-06-14 15:19:51 +02:00
624cf7d742
issue #70 crash
2013-06-06 18:59:11 +02:00
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
4208b21234
issue #65 ; see references no longer have multiple option, but can now allow custom formats
2013-05-27 14:47:26 +02:00
2bd2b23d7d
topics are added with nil description
2013-05-27 10:47:55 +02:00
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
cf7b8e3a9a
fixes issue #62 : keep LuaDoc compatibility, unless not_luadoc is explicitly set
2013-05-09 13:28:39 +02:00
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
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
a3cb09c098
Issue #61 sorted - not using Tags.add consistently
2013-05-06 11:38:20 +02:00
5beb1f048a
Merge branch 'master' of github.com:stevedonovan/LDoc
2013-04-17 12:08:44 +02:00
167a4595a5
built-in markdown crack down on locals; still very slow
2013-04-17 12:08:11 +02:00
68cd576bf4
module deduction can blow up; UTF BOM ignored
2013-04-16 10:11:05 +02:00
97af82c53d
bumped to 1.3.11
2013-04-13 16:15:54 +02:00
0ee96935a3
charset functionality was borked in general case
2013-04-03 12:20:54 +02:00
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
897061ac17
squashed trailing space problem with section titles; allowing numbers in links
2013-03-28 13:06:42 +02:00
158aa9ff14
can override utf-8 with either 'charset=<cs>' or per-module with @charset <cs>
2013-03-27 15:50:37 +02:00
d176dedcfc
bump version to 1.3.8 in usage; ignore empty docstrings (Dirk bug)
2013-03-26 11:53:42 +02:00
0706681e72
using parameters which were List method names caused chaos
2013-03-25 10:12:20 +02:00
a7b01abd03
module at-references now working! No-contents warning fixed
2013-03-23 17:51:55 +02:00
a8ea31b01d
fixed opt bug and weird issue when section title clashes with standard section names
2013-03-21 19:52:53 +02:00
741cba8ff2
merging trailing [opt] as [optchain]s. Trying to solve 'self' references in modules
2013-03-20 14:41:54 +02:00
65723a9dc4
issue #57 : [opt=default] support - see tests/styles/four.lua
2013-03-19 15:00:57 +02:00
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
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
dee7cd200a
fixed issue #47 ; flag-style tags like @local were blowing up with description collection
2013-03-07 13:49:39 +02:00
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
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
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
95f293e67e
ordinary non 'method' functions of a 'class' must be respected, and not prefixed with class:
2013-03-05 17:56:30 +02:00
357ee3978d
don't strip multiline tag values. Allows multiline @usage blocks to work nicely
2013-03-05 17:00:33 +02:00
7ceb7cc00b
@usage code blocks are prettified
2013-03-05 16:21:54 +02:00
1b67b1cd6f
wrap=true in config.ld will switch off nowrap in name column of function tables
2013-02-13 14:44:33 +02:00
394ba636bc
link fix in docs and anti-global jihad
2013-02-13 14:15:29 +02:00
55bbeed4f4
added module merging - see tests/merge directory (--merge flag)
2013-01-28 11:23:31 +02:00
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
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
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
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
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
29134ef169
tags as ordered maps; Geoff refactorings
2012-12-29 12:07:26 +02:00
cdebc952e4
usage section is now after returns: bumped vs to 1.3
2012-12-29 12:05:51 +02:00
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
b039ac1574
fix for last Geoff patch (was asleep)
2012-12-28 11:00:10 +02:00
0f68f97513
added support for Luamark (Geoff)
2012-12-28 10:56:43 +02:00
4801a6ba10
export tag gives warnings if an item has not been documented
2012-12-22 16:29:42 +02:00
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
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
3f70bd16f8
Ignore first non-doc comment (Geoff)
2012-12-21 18:23:18 +02:00
754da6e8d8
usage strings were not HTML-escaped properly (Eric)
2012-12-13 19:18:24 +02:00
8869cf4924
tparam macros can be used in table definitions
2012-12-13 19:17:32 +02:00
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
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
ac29c8e9c6
Added Geoff commit by hand: The table parser didn't handle tables with a trailing comment { a=1,
2012-12-10 09:39:12 +02:00
7f6835d253
pl.dir was not imported
2012-12-07 13:08:31 +02:00
5fbe6718ce
table field inference borked by recent changes; tests/simple/tables.lua is now behaving better
2012-11-11 18:50:33 +02:00
a560d75fde
relaxed argcheck-like style without at-signs; see example file
2012-11-08 19:09:59 +02:00
2b304a2252
Use classes for formatting argument descriptions rather than tags
2012-10-29 13:26:07 +13:00
9924e4dced
Parse type expressions like '?table|string' and turn them into 'optional table or string'
2012-10-29 13:24:49 +13:00
90e87ece0c
Handle multi-line argument descriptions embedded in (and after) a function's formal parameters
2012-10-29 13:22:52 +13:00
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
53166f626f
Added a comple of missing requires
2012-10-29 13:14:54 +13:00
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
f474eccdf8
factory-style classes: see tests/factory.lua
2012-08-22 12:50:57 +02:00
78ffa7e651
Strip trailing whitespaces from output
2012-08-06 16:52:27 +00:00
04c6922eeb
custom see references; Lua 5.2 issue sorted
2012-07-30 12:36:28 -04: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
abd89a1ab8
builtin references are now .lua files for better LuaRocks integration
2012-03-19 15:04:16 +02:00
f9a778e33a
final tweaks to docs, pretty last-line problem
2012-03-19 13:09:01 +02:00
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
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
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
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
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
725e49f50e
malformed ref check did not allow - (in example file names)
2012-01-09 14:07:24 +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
steve donovan
Hisham Muhammad
Mooffie
abadc0de
Ignas Anikevicius
Geoff Leyland
Alexander V. Nikolaev