129 Commits

Author SHA1 Message Date
Jeff Williams
85cbed9c0c change loading process for plugins and Markdown highlighters; remove jsdoc/path
We now simply use `require()` to load plugins and Markdown highlighters.

Note that `@jsdoc/util.path.commonPrefix`, unlike `jsdoc/path.commonPrefix`, does not append `path.sep` to the return value.

Includes other minor cleanup.
2019-01-27 15:18:28 -08:00
Jeff Williams
6220b76a3d remove jsdoc/fs 2019-01-26 21:00:19 -08:00
Jeff Williams
22e3ccacf9 remove jsdoc/util/dumper 2019-01-26 15:26:11 -08:00
Jeff Williams
02c1722eb9 use lodash to clone objects 2019-01-21 19:59:33 -08:00
Jeff Williams
5f578e803b migrate from old, vendored Jasmine to jasmine package (#1602)
Plus some miscellaneous cleanup.
2019-01-21 19:38:07 -08:00
Jeff Williams
3b8b0b479b migrate from underscore to lodash 2019-01-21 10:52:46 -08:00
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
8ac05f56f5 convert Markdown in the summary property (#1149) 2017-07-10 16:31:48 -07:00
Jeff Williams
8b26b6d669 remove author tags, and clean up JSDoc comments without leading asterisks
Most of the existing author tags are grossly out of date at this point. The definitive reference for who has contributed what is available at https://github.com/jsdoc3/jsdoc/graphs/contributors.
2017-07-06 00:01:11 -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
Jeff Williams
759243af08 add test for the Markdown fix in acc47fdfd19c53f8836e6ec5ade939c94c23013a 2015-12-08 16:18:29 -08:00
Tim Schaub
621f012211 Remove Rhino support 2015-10-30 13:11:43 -06:00
Alex Nicksay
13f09f397c Clean up space-after-keywords lint violations
This eliminates the following when running `gulp lint`:

> error  Keyword "catch" must be followed by whitespace

Closes #1083
2015-10-07 10:46:18 -04:00
Jeff Williams
93bd06c9e2 update gulp-eslint; delint 2015-08-13 16:23:19 -07:00
Jeff Williams
70d13b8948 update ESLint, and delint accordingly 2015-06-08 14:49:08 -07:00
Jeff Williams
09d0c1a0ed fix circular-refs issues 2015-03-09 16:52:09 -07:00
acbabis
e99ecb5dd4 Works for no comments 2015-02-24 14:15:43 -07: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
0e571265d4 process Markdown links in author tag (#878) 2015-01-15 07:41:30 -08:00
Daniel Ellis
dda789ae76 Squashed commit of the following:
commit 6010d34fcb7380281914f348023422f486033c68
Author: Daniel Ellis <coug36@gmail.com>
Date:   Wed Dec 31 09:29:00 2014 -0800

    Removed support for deprecated functionality

commit dba51a6ba74aa0de5c376434004eec8b05e1207b
Author: Daniel Ellis <coug36@gmail.com>
Date:   Fri Dec 26 11:51:08 2014 -0800

    Updated underscore plugin to pass tests

commit 3739ea55bd33186cbf507db3f086c9cf1ea9a339
Author: Daniel Ellis <coug36@gmail.com>
Date:   Sat Dec 13 21:33:48 2014 -0800

    Added unit tests for underscore plugin

commit 1b1bda5bb77ee74c311dfc9c9fe299e1e99f84cc
Merge: adfa364 a122ae6
Author: Daniel Ellis <coug36@gmail.com>
Date:   Sat Dec 13 18:39:32 2014 -0800

    Merge remote-tracking branch 'upstream/master' into underscore

commit adfa3646ebb7f11db897f7d0ba2490de79f86e2b
Author: Daniel Ellis <coug36@gmail.com>
Date:   Fri Aug 2 10:30:40 2013 -0700

    Added underscore plugin
2014-12-31 10:09:57 -08:00
Jeff Williams
416b42fa75 update ESLint; delint 2014-12-13 09:39:21 -08:00
Jeff Williams
36065d22e8 add exception/throws to default tag list for Markdown plugin (#736)
Plus some test refactoring.

Thanks to @otakustay for suggesting this change.
2014-11-07 15:18:07 -08:00
Jeff Williams
a2e119a88b update ESLint dependency; enable new rules; delint 2014-10-27 12:58:32 -07:00
Jeff Williams
b28f3341a3 delint 2014-10-26 05:52:03 -07:00
Jeff Williams
addee8ea7e split up the JSDoc and Closure Compiler tag definitions (#729)
A new `tags.dictionaries` config setting allows you to choose which definitions to enable.

If a tag is defined in more than one dictionary, JSDoc will use the definition from the first dictionary.
2014-08-13 13:39:14 -07:00
Jeff Williams
cfd9743eaa remove extra period from end of summary 2014-07-28 18:49:53 -07:00
Jeff Williams
ca62994d22 clean up/rename summarize plugin, and add tests 2014-07-26 19:51:55 -07:00
Jeff Williams
fa53887490 Plugin to automatically extract a summary, if missing, from the first sentence in the description
This plugin (tries to) extract a summary, if missing, from the first sentence in the description.

It does this by splitting at the first . that is followed by a whitespace or an HTML tag. Afterwards, it appends a ., balances any HTML tags and removes a begin-end pair of P tags.

The result is pretty useful, if the documenter has not "bothered" to write a summary and description tag.

Author: Mads Bondo Dydensborg <mbd@dbc.dk>
2014-07-26 15:06:59 -07:00
Jeff Williams
b5653b838c update ESLint rules for ESLint 0.7.1
Fixes a Travis CI build failure.
2014-07-07 21:36:20 -07:00
Jeff Williams
db7e65deb1 enable ESLint quotes rule (and associated cleanup) 2014-04-19 10:44:07 -07:00
Jeff Williams
bce238bb51 replace JSHint with ESLint (and associated cleanup) 2014-04-19 10:38:02 -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
c96a1215bd add a warning about potential crashes (#554) 2014-02-01 19:36:34 -08:00
Jeff Williams
ae93b5e614 add omitNodes option to hide AST nodes 2014-01-26 15:05:15 -08:00
Jeff Williams
733eb6bc47 log objects in events more consistently 2014-01-26 09:37:36 -08:00
Jeff Williams
c9b0237c12 overhaul logging and error handling (#416) 2013-12-23 15:25:28 -08:00
Jeff Williams
f55feb1a0e 'use strict'ify 2013-11-11 23:49:54 -08:00
Jeff Williams
6651a85b35 Merge branch 'master' into parsimony
Conflicts:
	lib/jsdoc/src/filter.js
	lib/jsdoc/src/scanner.js
	package.json
	test/specs/jsdoc/src/filter.js
	test/specs/jsdoc/src/scanner.js
	test/specs/tags/exportstag.js
2013-11-04 08:54:46 -08:00
Jeff Williams
99ab99298d add partial test infrastructure to support testing multiple parsers in one runtime
not fully implemented.
2013-11-04 06:46:47 -08:00
Jeff Williams
84188d6e62 don't escape inline HTML in Markdown-tagged text; remove markdown-js parser, and default to marked (#510) 2013-11-02 12:37:34 -07:00
Jeff Williams
7ac6bfee1c cleanup 2013-10-31 15:32:08 -07:00
Jeff Williams
e17b785a43 whitespace 2013-10-31 09:25:24 -07: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
Ernst Haagsman
d4ee1d324e Plugins: Created processingComplete event
The processingComplete event fires after all processing has been
done. It gets the entire docs as its only parameter.
2013-05-10 11:56:34 +02:00
Jeff Williams
f97803ad69 use Object.keys instead of Object.hasOwnProperty where possible 2013-05-02 20:06:04 -07:00
Jeff Williams
140883c553 Merge pull request #297 from phasmal/add-see-tag-support
Added support for @see tag in markdown plugin
2013-04-19 15:08:33 -07:00
Jeff Williams
359fa84d3c add plugin making it easier to link to overloaded methods (#179) 2013-04-15 06:55:45 -07:00