3e4bb302da
Avoid return documentation slipping into preceding function documenation
2015-12-23 14:20:49 +01:00
b5e02a655b
Allow "]" in description after tag modifiers
2015-12-11 08:56:45 +01:00
b9803db8ff
Adding module-level see reference support.
2015-10-16 13:34:31 -07:00
b248a2e035
Modifications to pull #207 ; enable backward compatibility and fixed spelling mistake
2015-09-28 15:33:18 +02:00
26b9a79384
Merge pull request #207 from zjarkov/master
...
Using ldoc.prettify_files the same way as for example ldoc.examples
2015-09-28 14:41:39 +02:00
0577744bef
Merge pull request #198 from xelivous/patch-1
...
add missing parenthesis in ldoc_ltp.lua
2015-09-28 13:56:36 +02:00
9f6c84f8bc
Using ldoc.prettify_files the same way as for example ldoc.examples
2015-07-24 17:18:13 +02:00
5da1fa11d4
update rockspecs in repo, fix css
2015-04-28 11:55:19 +02:00
134313e9a0
add missing parenthesis in ldoc_ltp.lua
2015-03-28 23:31:42 -05:00
205f72b313
Fix @{error} links
...
For some reason "error" was missing from the global functions list.
2014-12-29 13:30:47 +02:00
22e7055f03
Have postprocess_html
2014-12-24 17:51:05 +02:00
e6fb2fedd2
Merge pull request #187 from mooffie/section_css
...
Have CSS classes for section header and description
2014-12-21 09:50:24 +02:00
5f5c55cca9
CSS cleanup
...
Two changes in this patch:
(1) Two repeating CSS chunks were moved to their own files:
- Yahoo's "reset" styles were moved to '_reset_css.lua'.
- The code prettifier's styles were moved to '_code_css.lua'.
(The underscore at the filename's start is to show that it's not an
independent file but intended to be embedded in another.)
(2) Everything in "pre.example" that's already in "pre" was removed
(leaving just the font-size).
CAVEAT: the two new files need to be added to the 'rockspec' file.
2014-12-20 22:50:44 +02:00
24a6b27338
Have CSS classes for section header and description
2014-12-16 12:08:08 +02:00
ec97770051
Merge pull request #185 from mooffie/user_keywords
...
Support used-defined keywords (in prettified code).
2014-12-15 18:58:04 +02:00
69a4419420
Merge pull request #184 from mooffie/custom_display_name_for_project_level_items_too
...
Make custom_display_name work for project-level items
2014-12-15 18:57:37 +02:00
3313e78b44
Support used-defined keywords (in prettified code).
2014-12-15 10:05:50 +02:00
fc768df17e
Make custom_display_name work for project-level items
...
This lets users customize the way module/topic/file/etc names are shown.
2014-12-14 16:32:16 +02:00
eef66575d6
Fix undefined quote in Item:build_return_groups
2014-11-19 19:55:45 +01:00
25fd0b6bed
escape <> for HTML; uniform 14em navbar; uppercase C
2014-11-01 16:45:08 +02:00
c23e2a9b6f
changed prettify keyword colour to make it more distinct from link; pushed up <code> size; cleaned up style-sheet-found-error
2014-10-28 15:40:32 +02:00
d56252b762
fixed style sheet added
2014-10-26 21:15:29 +02:00
c516eebd12
version bump; underscore escaping fix for backticks; horrible workaround for deficiencies of C lexer
2014-10-25 12:01:48 +02:00
2fbe566039
Bumped version to 1.4.3; doc updates; C lexer ignores strings (which it handles badly)
2014-10-21 17:57:26 +02:00
3117f6f791
fix for underscore escape when using markdown.lua; do not use in prettified code blocks
2014-10-15 18:48:39 +02:00
2639ddec9f
issue #172 spurious space; still cleaning out tab infestation
2014-10-13 19:38:11 +02:00
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
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
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
416b541a5c
issue #180 : make target function clearer with highlighting
2014-10-01 16:05:03 +02:00
2778e043ed
issue #169 : make sure ldoc is not nil before checking config
2014-10-01 16:02:38 +02:00
c34957cd16
issue #178 Allow class merging
2014-09-28 18:54:17 +02:00
049945ce3d
Merge pull request #176 from hanxi/master
...
add update time to the footer of page
2014-09-26 10:48:04 +02:00
c979700ae6
Issue #177 : annotation rendering fixed
2014-09-15 20:02:28 +02:00
609805a7a7
add update time to the page footer
2014-09-10 10:37:11 +08:00
160eda087e
Merge branch 'master' of github.com:stevedonovan/LDoc
2014-06-27 15:55:12 +02:00
9a5b556a2d
summary/description with type/section fixed
2014-06-27 15:50:21 +02:00
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
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
a0c780f093
allow Markdown headers in module docstring by stripping #..
2014-06-20 15:09:38 +02:00
bf0f1384b9
Updated pale theme
2014-05-26 17:58:43 +02:00
3f32313ced
#158 summary line lost with @type tag
2014-05-25 13:58:25 +02:00
6d29aef7f2
allow tags to contain digits
2014-04-25 15:59:54 +02:00
1f21b5efa3
workaround for Lua file methods #157
2014-04-23 13:38:58 +02:00
624ff11afd
parameter names which were List methods overwriting object - factor out as map field
2014-04-23 13:19:16 +02:00
251dc88f93
deterministic ordered file processing
2014-04-23 10:20:55 +02:00
511dfe7df0
ldoc.custom_references to create new @{KIND:NAME} reference schemes; doc updates
2014-01-21 19:51:55 +02:00
2c0d459a43
bumped version to 1.4.2
2014-01-16 09:53:29 +02:00
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
d367390c68
Issue #150 : 'info' section ordering is now consistent
2014-01-07 17:48:50 +02:00
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
7c49337402
Resolve issue #22 'In-line links with underscores are broken'
2014-01-06 16:10:12 -05:00
04dc148df6
Issue #145 : do not expand annotations if there's no previous item
2014-01-06 15:03:09 +02:00
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
Thomas Weber
cjtallman
Steve Donovan
Steve J Donovan
Jaroslav Vaculik
Thijs Schreijer
xelivous
Mooffie
Michal Cichra
hanxi
Gary V. Vaughan
vanzomerenc
Hisham Muhammad
abadc0de