312 Commits

Author SHA1 Message Date
Jeff Williams
b8012f482d Update dependencies, plus the URLs for the GitHub repos and docs. 2019-05-04 16:04:57 -07:00
Jeff Williams
aa0b6c1bfa switch to new-ish ECMAScript syntax
With help from Lebab, plus a lot of manual cleanup. (And more cleanup to come, I'm sure.)
2019-01-15 18:39:10 -08:00
Jeff Williams
67e19bfc3a hide the signature in the heading for classes with hidden constructors (#1397) 2017-07-29 14:14:18 -07:00
Jeff Williams
832dfd704a move namespaces and interfaces up in the nav (#1410) 2017-07-23 12:34:56 -07:00
Jeff Williams
a63337b5c8 don't pretty-print code blocks that begin with "```plain" (#1361) 2017-07-23 12:30:07 -07:00
Jeff Williams
2f99af8fbb support the modifies tag (JSDoc and Closure Compiler) (#605) 2017-07-21 17:29:47 -07:00
Jeff Williams
9c97ba7495 link to interfaces that belong to a namespace (#1406) 2017-07-13 15:40:16 -07:00
Jeff Williams
f17395302f hide parameters and properties for hidden constructors (#1397) 2017-07-10 20:05:08 -07:00
Jeff Williams
c61f1cdf87 prevent a crash when a parameter has a weird name like {Object) (#1221) 2017-07-10 12:55:05 -07:00
Jeff Williams
c50a4c027a add yields tag (#1388) 2017-07-09 12:46:27 -07:00
Jeff Williams
d95cbdd9c9 support namespaces that are also functions (#955) 2017-07-07 19:48:08 -07:00
Jeff Williams
9f8853acff add hideconstructor tag (#952) 2017-07-07 14:59:07 -07:00
Jeff Williams
15b57e52f3 overhaul ESLint config; delint 2017-07-05 21:05:52 -07:00
Akaexus
c65ac8f05e CSS fix for wide images (#1359) 2017-07-03 17:03:17 -07:00
Jeff Williams
68a762e689 update dependencies; delint 2017-07-02 15:46:58 -07:00
Jeff Williams
cc1b966057 Merge branch 'dep-up-minor' of https://github.com/bjornharrtell/jsdoc into bjornharrtell-dep-up-minor 2016-08-26 16:41:41 -07:00
Jeff Williams
ea838e39a4 fix outdated link to Underscore.js (#1241) 2016-08-25 17:00:18 -07:00
Björn Harrtell
34c6eb9ffd Update gulp-eslint and minor style fixes to adapt to new eslint version 2016-03-31 21:17:41 +02:00
Kevin Locke
67d3693214 Create silent template
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>
2016-02-24 14:28:53 -08:00
Jeff Williams
bce36281b6 use appropriate styling for all tables (#1064) 2015-12-14 16:25:57 -08:00
Jeff Williams
3734dd621a differentiate CSS for h2 and h3 elements (#1108) 2015-12-08 15:55:39 -08:00
Vazha Omanashvili
4f9545c13b fix displaying of falsy default values in haruki template 2015-09-10 20:54:50 +03:00
Sebastian Noack
3f9a471840 Added option to use longnames in navigation to default template 2015-08-08 22:44:45 +02:00
Jeff Williams
6d3be696f6 Merge pull request #1013 from TimOgilvy/patch-1
Remove whitespace from around object name
2015-07-29 15:45:16 -07:00
Jeff Williams
5b0b60ec44 fix crash in haruki template (#1005) 2015-06-07 13:53:32 -07:00
Tim
b59875087a Remove whitespace from around object name
Prevents unnecessary space between ancestors and object name.
2015-05-25 17:48:24 +10:00
Jeff Williams
9cd830383e copy user-specified static files to the correct location when the output directory is an absolute path (#939) 2015-03-05 15:28:20 -08:00
Jeff Williams
ae94af0cd8 turn env global into a module, and use the module instead of the global (#812)
The `env` global remains available, since templates and plugins may rely upon it, but it's deprecated as of JSDoc 3.4.0.
2015-02-17 19:07:10 -08:00
Juan Cruz Viotti
254391e138 Allow disabling footer date with includeDate template config (#910) 2015-02-10 08:17:27 -04:00
Jeff Williams
eadccea5d2 use a nested table for every param with properties, not just the first one (#901) 2015-02-02 08:24:28 -08:00
Timothy Gu
105bdfe467 Remove margins for paragraphs in .props too 2015-01-24 18:26:48 -08:00
Jeff Williams
fb2c36781f update ESLint; delint 2015-01-11 19:17:44 -08:00
Jeff Williams
dad0544e93 show tutorials in the TOC nav (#875) 2015-01-11 18:30:08 -08:00
Jeff Williams
b7812b5de4 support properties on objects in arrays (#870) 2015-01-09 12:54:53 -08:00
Jeff Williams
3c7f54f749 move font stuff to the correct README 2015-01-06 19:38:34 -08:00
itantik
d57c67d9af 'longname' property of tutorials is undefined
therefore uniqueness checking causes the navigation displays only one tutorial. Items without 'longname' should be omitted from checking.
2014-12-30 22:08:41 +01:00
itantik
1945e6322e Added missing argument to the buildMemberNav()
Four arguments are passed to the buildMemberNav(), but only three ones were defined.
2014-12-30 21:44:26 +01:00
Jeff Williams
c7ba890677 only show the "Constructor" heading if there's a classdesc (#854) 2014-12-29 16:54:03 -08:00
Jeff Williams
7e23a68c59 multiple fixes for overridden symbols (#855)
- 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.
2014-12-29 15:48:05 -08:00
Jeff Williams
0080e5f99f if a symbol shares its longname with a module, only show the symbol if it either a) has a description or b) is a class (#853) 2014-12-28 12:32:47 -08:00
Jeff Williams
9a18e361fe remove huge paragraph margin (#844) 2014-12-22 13:38:05 -08:00
Jeff Williams
0fc0244ab6 close ul element correctly (#843)
Fixes validation errors.
2014-12-19 16:38:24 -08:00
Jeff Williams
e7f55594a1 add required dd elements (#843)
Fixes validation errors.
2014-12-19 16:32:38 -08:00
Jeff Williams
feb96ea7f5 remove dictionary-list wrappers (#843)
Fixes validation errors. Also results in fewer sections being indented, which, to my eye, looks nicer and is easier to read.
2014-12-19 16:27:23 -08:00
Jeff Williams
faee92618d use CSS to clear the br element (#843)
Fixes a validation error.
2014-12-19 16:25:49 -08:00
Jeff Williams
16f8270430 add missing dictionary list wrappers 2014-12-18 17:32:01 -08:00
Jeff Williams
61819f1105 close list elements 2014-12-18 17:21:55 -08:00
Jeff Williams
416b42fa75 update ESLint; delint 2014-12-13 09:39:21 -08:00
Jeff Williams
ee2badcde2 improvements from @dchambers to nav-building code (#813)
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
2014-12-06 15:50:28 -08:00
Jeff Williams
1a975c0f6d remove duplicate Requires section in modules (#790) 2014-11-11 20:14:38 -08:00