This commit creates a template named `silent` which outputs nothing at
all. As discussed in the `README.md`, this can be useful when running
JSDoc as a linter to check for syntax errors or unknown tags. It may
also be useful for testing or benchmarking.
The same effect can be achieved using the haruki template and
redirecting the output to /dev/null, but this has a few downsides:
* It is non-obvious.
* It is difficult to do in scripts which must run in bash and cmd.exe
(like npm scripts).
* It is slower due to the unnecessary formatting work and output
syscalls.
This template could be distributed as a third-party template, but given
the tiny code size, broad applicability, and potential usefulness for
tests, it makes sense to include it officially.
Signed-off-by: Kevin Locke <kevin@kevinlocke.name>
- Don't add an "overrides" property to members that are merely inherited.
- In the template, don't show both "overrides" and "inherited from" for the same member.
Squashed commit of the following:
commit 723349a9c90a005137d01e19012778f4dddb1d12
Author: dchambers <dominic.chambers@gmail.com>
Date: Fri Dec 5 13:14:13 2014 +0000
Moved an assignment within the corresponding guard, since it was superfluous unless the guard was triggered.
commit 872974656e7500c99daba64e7db31f14f9874c0d
Author: dchambers <dominic.chambers@gmail.com>
Date: Fri Dec 5 11:35:33 2014 +0000
Use four spaces for tabulation.
commit 5eaabcf84c5395aeeeff018ea042e73d710e2846
Author: dchambers <dominic.chambers@gmail.com>
Date: Mon Nov 24 18:15:36 2014 +0000
Attempt to fix remaining linting errors -- may not work as I'm unable to run the build locally on my own machine to verify.
commit 0137865ff4aa4e888533a217f2e6bb3b12b7fc87
Author: dchambers <dominic.chambers@gmail.com>
Date: Mon Nov 24 17:42:09 2014 +0000
Attempt to fix remaining linting errors -- may not work as I'm unable to run the build locally on my own machine to verify.
commit 7d80410d63e29837b436776b8983004c8b92ecb2
Author: dchambers <dominic.chambers@gmail.com>
Date: Mon Nov 24 17:17:51 2014 +0000
Removed trailing whitespace from 'publish.js'.
commit 773b785756f5ee6c32cbcb1742543c1a2671efe7
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date: Tue Aug 26 09:58:50 2014 +0100
Ensure the title for classes defined within modules shows the thing
being documented as being a class rather than a module, as it currently
does for interfaces.
commit 9fc527d63aa6839fbae07f4b6db8dee027f6fc43
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date: Tue Aug 26 09:51:10 2014 +0100
Remove the 'module:' prefix from index links to classes and interfaces
defined within modules.
commit 21e3e31f2499bbc9cb5f10c09cfaeb86d25ded9b
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date: Tue Aug 26 09:43:13 2014 +0100
Removed duplicated code from the buildNav() function, where the version
of the code used is one where items are only written if they haven't
already been encountered, and a heading is only written when there are
items to appear beneath that heading.
Conflicts:
templates/default/publish.js
Squashed commit of the following:
commit eb310340ae542152ae5fd15b070e389a17b71913
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date: Wed Nov 5 17:24:19 2014 +0000
Updated to use the same set of monospace typefaces as MDN too.
commit 5ff2591f8c3711e20f87eeb2e41347396d201414
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date: Wed Nov 5 17:15:28 2014 +0000
Add font re-generation instructions to the README.
commit bb4502a308936a31684732104b09ae737e6fbaec
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date: Wed Nov 5 16:11:06 2014 +0000
Added additional variations of the OpenSans typeface.
commit 125f2c91e767c7fa853ffa3222e7ed7d02f027b8
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date: Wed Nov 5 15:33:44 2014 +0000
Moved the web fonts into a separate 'fonts' directory.
commit 968998c677a946e79910b96cff2cb4c29898eb48
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date: Wed Nov 5 15:24:46 2014 +0000
Removed a negative margin hack we no longer seem to need.
commit 82f96d67cd3067ba6fd3deadee13e8853eb58491
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date: Wed Nov 5 15:13:15 2014 +0000
Removed the 'Summary' heading, plus re-jigged the formatting so there isn't too much space before the content.
commit db9dfad5c2339ea6d36a400b59da0447d446920d
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date: Wed Nov 5 14:23:05 2014 +0000
Fix for styling that was incorrectly being applied to each item in a list, rather than to the list itself.
commit 774271bd4e74ea429df7e5ae8fb9473097b81a1b
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date: Wed Nov 5 14:14:04 2014 +0000
For consistency, ensure there is always a space after the colon used to delimit CSS rule pairs.
commit 88d59794b0442e594bedf6fb17a638923ac67c2a
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date: Wed Nov 5 14:07:31 2014 +0000
Replace tabs with spaces to be consistent with the remainder of the stylesheet.
commit 37e5043403441a19cbe0cf2e2f4dec8ceba6cacb
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date: Wed Nov 5 14:02:34 2014 +0000
Use the same color for headings that MDN does.
commit 8f925659efd7a6c9996bf2a8dcebb174f79dc8d8
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date: Fri Aug 22 09:46:41 2014 +0100
Accidentally missed from previous check-in.
commit e98b060822b018c1403b98c92400052565d69e20
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date: Fri Aug 22 09:46:11 2014 +0100
Updated the license to reflect the inclusion of the Open Sans typeface,
plus included EOT and SVG versions of the font so that older version of
IE and Android browser also get to see the page rendered correctly.
commit 7e1a581bca931603e738e5afc238e7f211c9d444
Author: Dominic Chambers <dominic.chambers@gmail.com>
Date: Thu Aug 21 14:32:02 2014 +0100
Rebased the template typography off of the Mozilla Developer Network
site so generated API docs have a more contemporary and familiar style.
- In the default template, look for the list of static file paths in the
config property `templates.default.staticFiles.include`. (You can still
use `paths` instead of `include`.)
- Handle path-normalization issues that prevented the default template
from copying user-specified static files on Windows.
- Normalize paths in `fs.toDir` so that callers get the correct path
separator on Windows.
