153 Commits

Author SHA1 Message Date
Jeff Williams
a29a03b2d9 move jsdoc/util/logger into a new package 2019-01-19 21:49:27 -08: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
832dfd704a move namespaces and interfaces up in the nav (#1410) 2017-07-23 12:34:56 -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
15b57e52f3 overhaul ESLint config; delint 2017-07-05 21:05:52 -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
Sebastian Noack
3f9a471840 Added option to use longnames in navigation to default template 2015-08-08 22:44:45 +02: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
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
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
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
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
7807ac021e rename "Index" to "Home" (#750)
Thanks to @dchambers for the suggestion.
2014-11-08 10:54:14 -08:00
Jeff Williams
fc2b4ad3d2 fix Windows path issues and static-file copying (#785)
- 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.
2014-10-30 12:06:26 -07:00
Jeff Williams
b28f3341a3 delint 2014-10-26 05:52:03 -07:00
Jeff Williams
25ffab0676 prevent a crash when a package file specifies a name, but not a version 2014-10-17 12:44:35 -07:00
Jeff Williams
d527f3e6b0 prevent crash when a returns tag does not have a value (#751) 2014-09-05 15:30:21 -07:00
Jeff Williams
61e637bae6 if a module exports only an overloaded method, show every version of the method (#727) 2014-08-12 09:50:11 -07:00
MinHyeong Kim
ef70ffe2bd modify codes for @interface, @implements annotation. 2014-08-11 16:01:59 -07:00
Jeff Williams
8c66aef685 fix several template issues for modules (#522, #672)
- Show type info for modules that export something other than a class or a function. (#672)
- Do not duplicate the module description at the start of each page.
- Display the module description before the class description. (#522)
2014-06-30 20:55:57 -07:00
Jeff Williams
14d11c2844 remove parameter properties from the method signature (#680) 2014-06-22 19:45:02 -07:00
Jeff Williams
329db29c4f fix syntax for modules that export a single constructor (#655) 2014-05-29 18:51:36 -07:00
Jeff Williams
073d7e83e3 enable ESLint space-infix-ops rule (and associated cleanup) 2014-04-19 11:04:53 -07:00
Jeff Williams
bce238bb51 replace JSHint with ESLint (and associated cleanup) 2014-04-19 10:38:02 -07:00
Jeff Williams
254dda50b1 show more info for Closure Compiler type expressions (#618) 2014-04-18 16:46:34 -07:00
Jeff Williams
49ad746e49 trailing whitespace cleanup 2014-03-04 13:47:57 -08:00
Jeff Williams
48e6c392d5 huge whitespace cleanup
- remove all trailing whitespace
- for consistency, replace all tabs with spaces
2014-03-03 07:43:01 -08:00
Jeff Williams
39daa9ab23 hide source location if outputSourceFiles is false (#571)
revised fix to address the regression in #592
2014-03-01 08:18:08 -08:00
Jeff Williams
3caf49520d Revert "hide source location if outputSourceFiles is false (#571)"
Caused regression #592.

This reverts commit 8a50d1f064fc719e4099faf426d81e45690f07fd.
2014-03-01 08:09:43 -08:00
Jeff Williams
8a50d1f064 hide source location if outputSourceFiles is false (#571) 2014-02-16 09:15:14 -08:00
Jeff Williams
c9b0237c12 overhaul logging and error handling (#416) 2013-12-23 15:25:28 -08:00
Jeff Williams
f00e390cf0 fix various filepath issues (including #541) 2013-12-08 13:51:44 -08:00
Jeff Williams
cbe3442221 allow users to override the default template's layout file with the templates.default.layoutFile config property (#480) 2013-12-01 10:06:22 -08:00
Jeff Williams
f55feb1a0e 'use strict'ify 2013-11-11 23:49:54 -08:00
Jeff Williams
f958ab0fd2 prevent doclet paths from being shortened twice (#514) 2013-11-05 20:52:59 -08:00
Jeff Williams
751bea1b0a fixes for Node.js compatibility (see details)
- new Rhino .jar to help find module paths
(https://github.com/hegemonic/rhino/commit/31b70105)
- make __dirname and process.cwd() provide the current module path; use
only env.dirname for JSDoc's home dir; fix callers
- get rid of jsdoc/util/include (and update test framework accordingly)
- avoid running Rhino/Node.js tests on the wrong runtime
- remove support for global 'publish' function, which relied upon
jsdoc/util/include
- update jsdoc/util/dumper for consistency with Node.js'
JSON.stringify()
- fix jsdoc/util/runtime to detect Node.js correctly
- add Node.js versions of jsdoc/fs and jsdoc/path
- other minor cleanup
2013-10-25 23:30:56 -07:00
Jeff Williams
9745685dde make the fs.statSync shim throw an error (consistent with Node.js) 2013-10-23 09:32:20 -07:00
livelazily
2b845d7590 read source files using user defined encodeing, fix #496 2013-09-28 15:40:32 +08:00
Jeff Williams
912f548343 make the default template generate pretty-printed source files by default (#454) 2013-08-04 23:46:21 -07:00
Jeff Williams
a2f947bd34 change 'virtual' to 'abstract' in default template output (#432) 2013-08-04 23:34:21 -07:00
Jeff Williams
01ce3042d1 prevent crashes in lenient mode when a returns tag has no value (#451) 2013-08-04 18:07:27 -07:00
Jeff Williams
f97803ad69 use Object.keys instead of Object.hasOwnProperty where possible 2013-05-02 20:06:04 -07:00
Jeff Williams
0042847a0d copy user-specific static files to the default template's output directory (#393) 2013-04-30 20:57:16 -07:00
Jeff Williams
525e6fa8ec make the "Global" heading clickable when the only globals are typedefs (#261) 2013-04-19 14:50:20 -07:00
Jeff Williams
407a718543 Merge branch 'pr/365' 2013-04-07 07:14:57 -07:00
Jeff Williams
e5be860cc4 support modules that export a single non-constructor function (#384) 2013-04-06 16:53:20 -07:00