Commit Graph

111 Commits

Author SHA1 Message Date
steve donovan 31ee8f5cbc Issue #174: @include tag for including processed documentation file into output; last item now has a distinct line number, and some nasty tabs have been removed 2014-10-12 18:35:19 +02:00
steve donovan 56ac2601c0 Tweaks to opt/optchain: (optional) is emitted after optional arguments without defaults. convert_opts (counter-intuitively) disables automatic opt->optchain promotion 2014-10-12 16:45:09 +02:00
steve donovan cfdc6f8f53 new feature: prettify_files makes per-item links to source; unless this field is 'show', don't put in index 2014-10-12 16:09:09 +02:00
Steve Donovan 2778e043ed issue #169: make sure ldoc is not nil before checking config 2014-10-01 16:02:38 +02:00
steve donovan c34957cd16 issue #178 Allow class merging 2014-09-28 18:54:17 +02:00
steve donovan c979700ae6 Issue #177: annotation rendering fixed 2014-09-15 20:02:28 +02:00
Steve Donovan 160eda087e Merge branch 'master' of github.com:stevedonovan/LDoc 2014-06-27 15:55:12 +02:00
Steve Donovan 9a5b556a2d summary/description with type/section fixed 2014-06-27 15:50:21 +02:00
steve donovan 9bd5dd0ec7 dont_escape_underscore defaults to true if markdown.lua is not used; global_lookup defaults to true if parse_extra.C 2014-06-22 17:14:08 +02:00
Steve Donovan acc6ed2ad3 prettify code blocks in module docstring. Two new ldoc flags: dont_escape_underscore (when not using markdown.lua) and global_lookup (when specifically wanting global lookup for single symbols 2014-06-20 15:11:40 +02:00
steve donovan 3f32313ced #158 summary line lost with @type tag 2014-05-25 13:58:25 +02:00
Steve Donovan 624ff11afd parameter names which were List methods overwriting object - factor out as map field 2014-04-23 13:19:16 +02:00
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 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
Steve Donovan 4294b2e2da Issue #114: trying harder to resolve references by unqualified method name 2013-11-28 11:57:13 +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 9ef1f08784 can resolve references to local class; no longer have 'Topic: ' for readme documents 2013-11-17 19:48:35 +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 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