Commit Graph

462 Commits

Author SHA1 Message Date
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 20ff72cd35 add changes document 2013-09-20 13:52:18 +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 89cb20d752 doc updates 2013-08-25 14:28:57 +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 1bf3461917 doc updates 2013-08-23 15:59:35 +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