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
ec97770051
Merge pull request #185 from mooffie/user_keywords
...
Support used-defined keywords (in prettified code).
2014-12-15 18:58:04 +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
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
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
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
609805a7a7
add update time to the page footer
2014-09-10 10:37:11 +08: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
624ff11afd
parameter names which were List methods overwriting object - factor out as map field
2014-04-23 13:19:16 +02:00
2c0d459a43
bumped version to 1.4.2
2014-01-16 09:53:29 +02:00
d367390c68
Issue #150 : 'info' section ordering is now consistent
2014-01-07 17:48:50 +02:00
f60e6d4197
Pull #121 applied manually - custom tags may be hidden
2013-12-09 15:13:00 +02:00
89854e1537
Custom tags
...
Custom tags
2013-11-28 10:46:59 -05: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
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
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
f33a09e4d3
issue #76 auto-scroll to avoid breaking identifiers
2013-08-27 12:44:04 +02:00
7da46268dc
'pale' template added; interpretation of --style and --template extended
2013-08-25 19:38:01 +02:00
149ded81fc
composite return types experiment
2013-08-25 10:47: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
5699d002ef
issue #77 : 'See also' in template
2013-08-20 14:59:13 +02:00
52e9b6f32c
new classmod tag for defining modules that just export one class (experimental)
2013-08-07 15:19:46 +02:00
94dc198f4b
support for generating Markdown; basic support for Moonscript
2013-08-05 19:27:42 +02:00
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
ac5c5f2c65
'plain=true' when format is set but you do not want doc comments treated specially. Backticks are now expanded in usage blocks
2013-05-09 12:52:15 +02:00
97af82c53d
bumped to 1.3.11
2013-04-13 16:15:54 +02:00
619d8e1710
-O for one col layout, -S for simple (no params,ret or summary); one col switches off function list. Bumped to 1.3.8
2013-03-28 13:28:05 +02:00
158aa9ff14
can override utf-8 with either 'charset=<cs>' or per-module with @charset <cs>
2013-03-27 15:50:37 +02:00
4bc48dafc3
modules returning a single function are supported, see tests/styles/func.lua. Parameters may have subfields, see tests/styles/subparams.lua
2013-03-18 15:51:28 +02:00
496b534ce1
@type summary no longer dropped ( #49 ); @type can be used with @usage ( #52 ); CSS tweaks for prettification; nasty '<pre/>' typo squashed
2013-03-07 13:09:48 +02:00
8856f09629
pretty field can be set to 'lxsh'; github-flavoured Markdown fenced code blocks; if lxsh, can also highlight c, sh and bib
2013-03-06 17:07:28 +02:00
7ceb7cc00b
@usage code blocks are prettified
2013-03-05 16:21:54 +02:00
1b67b1cd6f
wrap=true in config.ld will switch off nowrap in name column of function tables
2013-02-13 14:44:33 +02:00
1bb83924bb
in implicit function style (a la Geoff) the first comment refers to the return value. In colon style, an exclamation mark allows a typename to be directly used as a 'tag'. The word 'optional' is only issued if we have either nil or a type
2012-12-31 14:52:00 +02:00
cdebc952e4
usage section is now after returns: bumped vs to 1.3
2012-12-29 12:05:51 +02:00
754da6e8d8
usage strings were not HTML-escaped properly (Eric)
2012-12-13 19:18:24 +02:00
Mooffie
Steve J Donovan
Steve Donovan
hanxi
abadc0de