Commit Graph

380 Commits

Author SHA1 Message Date
hanxi bf11db2380 add update time to the page footer 2014-09-10 10:39:17 +08:00
hanxi 609805a7a7 add update time to the page footer 2014-09-10 10:37:11 +08: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 a0c780f093 allow Markdown headers in module docstring by stripping #.. 2014-06-20 15:09:38 +02:00
Steve Donovan 7b496aa05b accept examples written in any language supported by LDoc 2014-06-20 15:08:11 +02:00
Steve J Donovan 194a1a2fbe Merge pull request #163 from gns-ank/patch-5
Simularly -> Similarly in doc.md
2014-05-27 15:40:25 +02:00
Ignas Anikevicius 7efd14e14f Simularly -> Similarly in doc.md
This is an old typo and mentioned in #3 and #71. Since it has drifted again, I updated the patch.
2014-05-27 14:32:38 +01:00
Steve J Donovan f49f7b3021 Merge pull request #160 from gns-ank/patch-3
Fix a backtick in ## Markdown Support
2014-05-27 15:28:49 +02:00
Steve J Donovan 0f6b239c23 Merge pull request #161 from gns-ank/patch-4
Fix indentation in ## Markdown Support
2014-05-27 15:28:24 +02:00
Ignas Anikevicius 401bdd9726 Fix indentation in ## Markdown Support
This fixes indentation, so that the list has the same hierarchy.
2014-05-26 22:03:26 +01:00
Ignas Anikevicius 8bc5f722cc Fix a backtick in ## Markdown Support
There was an apostrophe instead of a backtick, which messed things up.
2014-05-26 21:58:25 +01:00
steve donovan bf0f1384b9 Updated pale theme 2014-05-26 17:58:43 +02:00
steve donovan 8b2b2e4625 #159 directory as argument case was broken 2014-05-25 14:11:00 +02:00
steve donovan 3f32313ced #158 summary line lost with @type tag 2014-05-25 13:58:25 +02:00
Steve Donovan 6d29aef7f2 allow tags to contain digits 2014-04-25 15:59:54 +02:00
Steve Donovan 1f21b5efa3 workaround for Lua file methods #157 2014-04-23 13:38:58 +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 251dc88f93 deterministic ordered file processing 2014-04-23 10:20:55 +02:00
steve donovan 511dfe7df0 ldoc.custom_references to create new @{KIND:NAME} reference schemes; doc updates 2014-01-21 19:51:55 +02:00
steve donovan b09f7f865f unknown typename check for kind_names; updated ldoc's config.ld 2014-01-18 16:13:15 +02:00
Steve Donovan e5605a4a94 kind_names variable can override names used in sidebar, e.g. 'kind_names={topic='Manual'}' will override default of 'Topics' 2014-01-17 15:59:39 +02:00
Steve Donovan 2c0d459a43 bumped version to 1.4.2 2014-01-16 09:53:29 +02:00
Steve J Donovan 2fb50d85e0 Merge pull request #154 from kernelp4nic/master
Updated LuaDoc url
2014-01-15 23:46:58 -08:00
Sebastián Moreno b2bf47ac02 Updated LuaDoc canonical URL 2014-01-15 12:16:58 -02:00
Sebastián Moreno 0c6bd7d8b6 Updated LuaDoc url 2014-01-14 18:58:41 -02:00
Steve Donovan 94439e8e64 updated changes.md - preparing for release 2014-01-10 15:50:44 +02:00
Steve J Donovan 36f1393a01 Merge pull request #151 from gvvaughan/pull-request/case-sensitive-filesystems
html: case sensitive file systems require matching require args.
2014-01-07 23:53:17 -08:00
Gary V. Vaughan fc0e6099fa html: case sensitive file systems require matching require args.
* ldoc/html.lua: Make sure to `require 'pl.OrderedMap'` (with a
capital 'O') to match the filename installed by penlight.

Signed-off-by: Gary V. Vaughan <gary@gnu.org>
2014-01-08 16:55:32 +13:00
steve donovan d367390c68 Issue #150: 'info' section ordering is now consistent 2014-01-07 17:48:50 +02:00
Steve J Donovan a8c4d9fa1e Merge pull request #149 from vanzomerenc/master
Resolve issue #22 'In-line links with underscores are broken'
2014-01-07 01:19:37 -08:00
vanzomerenc 7c49337402 Resolve issue #22 'In-line links with underscores are broken' 2014-01-06 16:10:12 -05: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 60c6e79dd9 Issue #137 boilerplate Lua block comment 2014-01-06 13:35:12 +02:00
steve donovan 94975bcb8c Merge branch 'master' of github.com:stevedonovan/LDoc 2014-01-05 15:05:56 +02:00
Steve J Donovan aad096dced Merge pull request #129 from gvvaughan/pull-request/custom_see_hander-doc-fix
doc: improve match pattern for manual page references with custom_see_handler.
2014-01-05 05:05:07 -08: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 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