Commit Graph

339 Commits

Author SHA1 Message Date
Steve J Donovan b3f6fc2762 Merge pull request #140 from JonasT/patch-1
Being more direct on how tags look like when introducing them first
2013-12-31 01:02:41 -08:00
Steve J Donovan 21eff88c05 Merge pull request #142 from JonasT/patch-3
Major reordering and renaming of sections of documentation
2013-12-31 01:02:25 -08:00
Steve J Donovan 2d6cddce44 Merge pull request #141 from JonasT/patch-2
Rewrite of first introductory paragraph
2013-12-31 00:59:22 -08:00
JonasT ffec76bd56 Removing inconsistent header colon 2013-12-31 09:01:14 +01:00
JonasT e38a1b1402 Better section naming, some hints for C code 2013-12-31 09:00:30 +01:00
JonasT e3c9f5336a Fixing tag introduction example (hopefully?) 2013-12-31 08:54:56 +01:00
JonasT 2061b5fc11 Some more reordering, introducing tags more explicitly 2013-12-31 08:53:59 +01:00
JonasT 2bd0c3f760 Getting all the sections in a more beginner's friendly, logical order 2013-12-31 08:40:50 +01:00
JonasT 721d626b70 Rewrite of first introductory paragraph
A suggested rewrite of first introductory paragraph. It does drop some information (e.g. second generation) in favor of being more beginner's friendly and more basic in what this is actually about. The followup LDoc-referring paragraphs seem sufficient to cater the needs of advanced doc tool users, while the first paragraph possibly stumps and scares away beginners in its current form.
2013-12-31 08:18:33 +01:00
JonasT a870f91e59 Being more direct on how tags look like when introducing them first 2013-12-31 08:07:41 +01:00
Steve J Donovan 2db76970ab Merge pull request #138 from dirkfeytons/master
Fix issue #123: override 'boilerplate' was done too late
2013-12-24 05:52:12 -08:00
Dirk Feytons b16e85af7d Fix issue #123: override 'boilerplate' was done too late 2013-12-24 11:30:56 +01:00
Steve J Donovan bbc3183e35 Merge pull request #136 from hishamhm/master
Give command-line flags priority over the config file (plus minor fixes)
2013-12-21 00:15:30 -08: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
Hisham Muhammad 9b40e03e3a Command-line flags that were explicitly passed by the user should take precedence over config file defaults. 2013-12-21 00:41:41 -02:00
Hisham Muhammad 41a0d9b009 Add entries missing in rockspec. 2013-12-21 00:41:34 -02:00
Steve J Donovan c93c14709f Merge pull request #130 from mooffie/fix_prettifier_last_lines
Fix minor issues with the "prettify" facility.
2013-12-12 22:52:07 -08: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
Steve J Donovan d96eee4605 Merge pull request #122 from mooffie/custom_display_name_handler
Custom display_name handler.
2013-12-09 05:07:09 -08:00
Mooffie 3053079fee Custom display_name handler. 2013-12-09 12:23:27 +02:00
Steve J Donovan 94433da88f Merge pull request #116 from abadc0de/master
Custom tags
2013-11-28 23:58:04 -08: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 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