mirror of
https://github.com/jsdoc/jsdoc.git
synced 2025-12-08 19:46:11 +00:00
Update dependencies, plus the URLs for the GitHub repos and docs.
This commit is contained in:
Jeff Williams
parent
10c004f823
commit
b8012f482d
12
CHANGES.md
12
CHANGES.md
@ -73,7 +73,7 @@ language features:
|
||||
|
||||
+ You can now use a JavaScript file to configure JSDoc. The JavaScript file must be a CommonJS
|
||||
module that exports a single configuration object. See the
|
||||
[documentation](http://usejsdoc.org/about-configuring-jsdoc.html) for details and examples.
|
||||
[documentation](https://jsdoc.app/about-configuring-jsdoc.html) for details and examples.
|
||||
+ Fixed multiple issues with documenting ES2015 classes and modules. See "Bug fixes" for details.
|
||||
+ JSDoc now requires Node.js 4.2.0 or later.
|
||||
|
||||
@ -81,18 +81,18 @@ module that exports a single configuration object. See the
|
||||
|
||||
**Note**: Third-party templates may not support these new tags.
|
||||
|
||||
+ You can now use the new [`@async` tag](http://usejsdoc.org/tags-async.html) to indicate that a
|
||||
+ You can now use the new [`@async` tag](https://jsdoc.app/tags-async.html) to indicate that a
|
||||
function is asynchronous (that is, that it was declared with the syntax `async function foo() {}`).
|
||||
In general, you do not need to use this tag, because JSDoc autodetects asynchronous functions.
|
||||
(#1188)
|
||||
+ You can now use the new [`@generator` tag](http://usejsdoc.org/tags-generator.html) to indicate
|
||||
+ You can now use the new [`@generator` tag](https://jsdoc.app/tags-generator.html) to indicate
|
||||
that a function is a generator function. In general, you do not need to use this tag, because JSDoc
|
||||
autodetects generator functions. (#1158)
|
||||
+ You can now use the new [`@hideconstructor` tag](http://usejsdoc.org/tags-hideconstructor.html) to
|
||||
+ You can now use the new [`@hideconstructor` tag](https://jsdoc.app/tags-hideconstructor.html) to
|
||||
tell JSDoc to hide a class's constructor from the documentation. (#952)
|
||||
+ You can now use the new [`@package` tag](http://usejsdoc.org/tags-package.html) to indicate that a
|
||||
+ You can now use the new [`@package` tag](https://jsdoc.app/tags-package.html) to indicate that a
|
||||
symbol is package-private. (#962)
|
||||
+ You can now use the new [`@yields` tag](http://usejsdoc.org/tags-yields.html) to document the
|
||||
+ You can now use the new [`@yields` tag](https://jsdoc.app/tags-yields.html) to document the
|
||||
value that is yielded by a generator function. (#1388)
|
||||
|
||||
### Enhancements
|
||||
|
||||
@ -8,11 +8,11 @@ fastest way to get your pull request merged in.** Some things, particularly how
|
||||
you set up your branches and work with git, are just suggestions, but pretty good
|
||||
ones.
|
||||
|
||||
1. **Create a remote to track the base jsdoc3/jsdoc repository**
|
||||
1. **Create a remote to track the base jsdoc/jsdoc repository**
|
||||
This is just a convenience to make it easier to update your ```<tracking branch>```
|
||||
(more on that shortly). You would execute something like:
|
||||
|
||||
git remote add base git://github.com/jsdoc3/jsdoc.git
|
||||
git remote add base git://github.com/jsdoc/jsdoc.git
|
||||
|
||||
Here 'base' is the name of the remote. Feel free to use whatever you want.
|
||||
|
||||
|
||||
40
LICENSE.md
40
LICENSE.md
@ -1,15 +1,15 @@
|
||||
# License #
|
||||
# License
|
||||
|
||||
JSDoc 3 is free software, licensed under the Apache License, Version 2.0 (the
|
||||
JSDoc is free software, licensed under the Apache License, Version 2.0 (the
|
||||
"License"). Commercial and non-commercial use are permitted in compliance with
|
||||
the License.
|
||||
|
||||
Copyright (c) 2011-present Michael Mathews <micmath@gmail.com> and the
|
||||
[contributors to JSDoc](https://github.com/jsdoc3/jsdoc/graphs/contributors).
|
||||
All rights reserved.
|
||||
[contributors to JSDoc](https://github.com/jsdoc/jsdoc/graphs/contributors). All
|
||||
rights reserved.
|
||||
|
||||
You may obtain a copy of the License at:
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
You can obtain a copy of the License at:
|
||||
https://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
In addition, a copy of the License is included with this distribution.
|
||||
|
||||
@ -23,16 +23,14 @@ As stated in Section 7, "Disclaimer of Warranty," of the License:
|
||||
> appropriateness of using or redistributing the Work and assume any risks
|
||||
> associated with Your exercise of permissions under this License.
|
||||
|
||||
The source code for JSDoc 3 is available at:
|
||||
https://github.com/jsdoc3/jsdoc
|
||||
The source code for JSDoc is available at: https://github.com/jsdoc/jsdoc
|
||||
|
||||
# Third-Party Software #
|
||||
# Third-party software
|
||||
|
||||
JSDoc 3 includes or depends upon the following third-party software, either in
|
||||
whole or in part. Each third-party software package is provided under its own
|
||||
license.
|
||||
JSDoc includes the following third-party software, either in whole or in part.
|
||||
Each third-party software package is provided under its own license.
|
||||
|
||||
## MIT License ##
|
||||
## MIT License
|
||||
|
||||
Several of the following software packages are distributed under the MIT
|
||||
license, which is reproduced below:
|
||||
@ -55,7 +53,7 @@ license, which is reproduced below:
|
||||
> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
> SOFTWARE.
|
||||
|
||||
## Google Code Prettify ##
|
||||
## Google Code Prettify
|
||||
|
||||
Google Code Prettify is distributed under the Apache License 2.0, which is
|
||||
included with this package.
|
||||
@ -65,7 +63,7 @@ Copyright (c) 2006 Google Inc.
|
||||
The source code for Google Code Prettify is available at:
|
||||
https://code.google.com/p/google-code-prettify/
|
||||
|
||||
## Jasmine ##
|
||||
## Jasmine
|
||||
|
||||
Jasmine is distributed under the MIT license, which is reproduced above.
|
||||
|
||||
@ -74,7 +72,7 @@ Copyright (c) 2008-2011 Pivotal Labs.
|
||||
The source code for Jasmine is available at:
|
||||
https://github.com/pivotal/jasmine
|
||||
|
||||
## jasmine-node ##
|
||||
## jasmine-node
|
||||
|
||||
jasmine-node is distributed under the MIT license, which is reproduced above.
|
||||
|
||||
@ -83,7 +81,7 @@ Copyright (c) 2010 Adam Abrons and Misko Hevery (http://getangular.com).
|
||||
The source code for jasmine-node is available at:
|
||||
https://github.com/mhevery/jasmine-node
|
||||
|
||||
## Open Sans ##
|
||||
## Open Sans
|
||||
|
||||
Open Sans is distributed under the Apache License 2.0, which is
|
||||
included with this package.
|
||||
@ -91,14 +89,14 @@ included with this package.
|
||||
Copyright (c) 2010-2011, Google Inc.
|
||||
|
||||
This typeface, including the complete set of variations, are available at:
|
||||
http://www.google.com/fonts/specimen/Open+Sans
|
||||
https://fonts.google.com/specimen/Open+Sans
|
||||
|
||||
## Tomorrow Theme for Google Code Prettify ##
|
||||
## Tomorrow theme for Google Code Prettify
|
||||
|
||||
The Tomorrow Theme for Google Code Prettify is distributed under the MIT
|
||||
The Tomorrow theme for Google Code Prettify is distributed under the MIT
|
||||
license, which is reproduced above.
|
||||
|
||||
Copyright (c) 2016 Yoshihide Jimbo.
|
||||
|
||||
The source code for the Tomorrow Theme is available at:
|
||||
The source code for the Tomorrow theme is available at:
|
||||
https://github.com/jmblog/color-themes-for-google-code-prettify
|
||||
|
||||
93
README.md
93
README.md
@ -1,7 +1,6 @@
|
||||
JSDoc 3
|
||||
=======
|
||||
# JSDoc
|
||||
|
||||
[](http://travis-ci.org/jsdoc3/jsdoc)
|
||||
[](http://travis-ci.org/jsdoc/jsdoc)
|
||||
|
||||
An API documentation generator for JavaScript.
|
||||
|
||||
@ -10,86 +9,92 @@ Want to contribute to JSDoc? Please read `CONTRIBUTING.md`.
|
||||
Installation and Usage
|
||||
----------------------
|
||||
|
||||
JSDoc supports stable versions of Node.js 8.15.0 and later. You can install JSDoc globally or in
|
||||
your project's `node_modules` folder.
|
||||
JSDoc supports stable versions of Node.js 8.15.0 and later. You can install
|
||||
JSDoc globally or in your project's `node_modules` folder.
|
||||
|
||||
To install the latest version on npm globally (may require `sudo`; [learn how to fix
|
||||
this](https://docs.npmjs.com/getting-started/fixing-npm-permissions)):
|
||||
To install the latest version on npm globally (might require `sudo`;
|
||||
[learn how to fix this](https://docs.npmjs.com/resolving-eacces-permissions-errors-when-installing-packages-globally)):
|
||||
|
||||
npm install -g jsdoc
|
||||
|
||||
To install the latest version on npm locally and save it in your package's `package.json` file:
|
||||
To install the latest version on npm locally and save it in your package's
|
||||
`package.json` file:
|
||||
|
||||
npm install --save-dev jsdoc
|
||||
|
||||
**Note**: By default, npm adds your package using the caret operator in front of the version number
|
||||
(for example, `^3.5.2`). We recommend using the tilde operator instead (for example, `~3.5.2`),
|
||||
which limits updates to the most recent patch-level version. See [this Stack Overflow
|
||||
answer](https://stackoverflow.com/questions/22343224) for more information about the caret and tilde
|
||||
operators.
|
||||
**Note**: By default, npm adds your package using the caret operator in front of
|
||||
the version number (for example, `^3.5.2`). We recommend using the tilde
|
||||
operator instead (for example, `~3.5.2`), which limits updates to the most
|
||||
recent patch-level version. See
|
||||
[this Stack Overflow answer](https://stackoverflow.com/questions/22343224) for
|
||||
more information about the caret and tilde operators.
|
||||
|
||||
To install the latest development version locally, without updating your project's `package.json`
|
||||
file:
|
||||
To install the latest development version locally, without updating your
|
||||
project's `package.json` file:
|
||||
|
||||
npm install git+https://github.com/jsdoc3/jsdoc.git
|
||||
npm install git+https://github.com/jsdoc/jsdoc.git
|
||||
|
||||
If you installed JSDoc locally, the JSDoc command-line tool is available in `./node_modules/.bin`.
|
||||
To generate documentation for the file `yourJavaScriptFile.js`:
|
||||
If you installed JSDoc locally, the JSDoc command-line tool is available in
|
||||
`./node_modules/.bin`. To generate documentation for the file
|
||||
`yourJavaScriptFile.js`:
|
||||
|
||||
./node_modules/.bin/jsdoc yourJavaScriptFile.js
|
||||
|
||||
Or if you installed JSDoc globally, simply run the `jsdoc` command:
|
||||
If you installed JSDoc globally, run the `jsdoc` command:
|
||||
|
||||
jsdoc yourJavaScriptFile.js
|
||||
|
||||
By default, the generated documentation is saved in a directory named `out`. You can use the
|
||||
`--destination` (`-d`) option to specify another directory.
|
||||
By default, the generated documentation is saved in a directory named `out`. You
|
||||
can use the `--destination` (`-d`) option to specify another directory.
|
||||
|
||||
Run `jsdoc --help` for a complete list of command-line options.
|
||||
|
||||
Templates and Tools
|
||||
-------------------
|
||||
## Templates and tools
|
||||
|
||||
The JSDoc community has created numerous templates and other tools to help you generate and
|
||||
customize your documentation. Here are just a few:
|
||||
The JSDoc community has created templates and other tools to help you generate
|
||||
and customize your documentation. Here are a few of them:
|
||||
|
||||
### Templates
|
||||
|
||||
+ [jaguarjs-jsdoc](https://github.com/davidshimjs/jaguarjs-jsdoc)
|
||||
+ [DocStrap](https://github.com/docstrap/docstrap) ([example](https://docstrap.github.io/docstrap))
|
||||
+ [DocStrap](https://github.com/docstrap/docstrap)
|
||||
([example](https://docstrap.github.io/docstrap))
|
||||
+ [jsdoc3Template](https://github.com/DBCDK/jsdoc3Template)
|
||||
([example](https://github.com/danyg/jsdoc3Template/wiki#wiki-screenshots))
|
||||
+ [minami](https://github.com/Nijikokun/minami)
|
||||
+ [docdash](https://github.com/clenemt/docdash) ([example](http://clenemt.github.io/docdash/))
|
||||
+ [tui-jsdoc-template](https://github.com/nhnent/tui.jsdoc-template) ([example](https://nhnent.github.io/tui.jsdoc-template/latest/))
|
||||
+ [better-docs](https://github.com/SoftwareBrothers/better-docs) ([example](https://softwarebrothers.github.io/admin-bro-dev/index.html))
|
||||
+ [docdash](https://github.com/clenemt/docdash)
|
||||
([example](http://clenemt.github.io/docdash/))
|
||||
+ [tui-jsdoc-template](https://github.com/nhnent/tui.jsdoc-template)
|
||||
([example](https://nhnent.github.io/tui.jsdoc-template/latest/))
|
||||
+ [better-docs](https://github.com/SoftwareBrothers/better-docs)
|
||||
([example](https://softwarebrothers.github.io/admin-bro-dev/index.html))
|
||||
|
||||
### Build Tools
|
||||
### Build tools
|
||||
|
||||
+ [JSDoc Grunt plugin](https://github.com/krampstudio/grunt-jsdoc)
|
||||
+ [JSDoc Gulp plugin](https://github.com/mlucool/gulp-jsdoc3)
|
||||
|
||||
### Other Tools
|
||||
### Other tools
|
||||
|
||||
+ [jsdoc-to-markdown](https://github.com/jsdoc2md/jsdoc-to-markdown)
|
||||
+ [Integrating GitBook with
|
||||
JSDoc](https://medium.com/@kevinast/integrate-gitbook-jsdoc-974be8df6fb3)
|
||||
|
||||
For More Information
|
||||
--------------------
|
||||
## For more information
|
||||
|
||||
+ Documentation is available at [Use JSDoc](http://usejsdoc.org).
|
||||
+ Contribute to the docs at [jsdoc3/jsdoc3.github.com](https://github.com/jsdoc3/jsdoc3.github.com).
|
||||
+ Documentation is available at [jsdoc.app](https://jsdoc.app/).
|
||||
+ Contribute to the docs at
|
||||
[jsdoc/jsdoc.github.io](https://github.com/jsdoc/jsdoc.github.io).
|
||||
+ [Join JSDoc's Slack channel](https://jsdoc-slack.appspot.com/).
|
||||
+ Ask for help on the [JSDoc Users mailing list](http://groups.google.com/group/jsdoc-users).
|
||||
+ Post questions tagged `jsdoc` to [Stack
|
||||
Overflow](http://stackoverflow.com/questions/tagged/jsdoc).
|
||||
+ Ask for help on the
|
||||
[JSDoc Users mailing list](http://groups.google.com/group/jsdoc-users).
|
||||
+ Post questions tagged `jsdoc` to
|
||||
[Stack Overflow](http://stackoverflow.com/questions/tagged/jsdoc).
|
||||
|
||||
License
|
||||
-------
|
||||
## License
|
||||
|
||||
JSDoc 3 is copyright (c) 2011-present Michael Mathews <micmath@gmail.com> and the [contributors to
|
||||
JSDoc](https://github.com/jsdoc3/jsdoc/graphs/contributors).
|
||||
JSDoc 3 is copyright (c) 2011-present Michael Mathews <micmath@gmail.com> and
|
||||
the [contributors to JSDoc](https://github.com/jsdoc/jsdoc/graphs/contributors).
|
||||
|
||||
JSDoc 3 is free software, licensed under the Apache License, Version 2.0. See the file `LICENSE.md`
|
||||
in this distribution for more details.
|
||||
JSDoc 3 is free software, licensed under the Apache License, Version 2.0. See
|
||||
the file `LICENSE.md` in this distribution for more details.
|
||||
|
||||
2
cli.js
2
cli.js
@ -195,7 +195,7 @@ module.exports = (() => {
|
||||
cli.printHelp = () => {
|
||||
cli.printVersion();
|
||||
console.log( `\n${require('jsdoc/opts/args').help()}\n` );
|
||||
console.log('Visit http://usejsdoc.org for more information.');
|
||||
console.log('Visit https://jsdoc.app/ for more information.');
|
||||
|
||||
return Promise.resolve(0);
|
||||
};
|
||||
|
||||
2965
package-lock.json
generated
2965
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
67
package.json
67
package.json
@ -1,36 +1,39 @@
|
||||
{
|
||||
"name": "jsdoc",
|
||||
"version": "3.6.0-dev",
|
||||
"revision": "1547606083759",
|
||||
"revision": "1557009785474",
|
||||
"description": "An API documentation generator for JavaScript.",
|
||||
"keywords": ["documentation", "javascript"],
|
||||
"keywords": [
|
||||
"documentation",
|
||||
"javascript"
|
||||
],
|
||||
"license": "Apache-2.0",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/jsdoc3/jsdoc"
|
||||
"url": "https://github.com/jsdoc/jsdoc"
|
||||
},
|
||||
"dependencies": {
|
||||
"@babel/parser": "~7.2.3",
|
||||
"bluebird": "~3.5.0",
|
||||
"catharsis": "~0.8.9",
|
||||
"escape-string-regexp": "~1.0.5",
|
||||
"js2xmlparser": "~3.0.0",
|
||||
"klaw": "~3.0.0",
|
||||
"markdown-it": "~8.4.2",
|
||||
"markdown-it-anchor": "~5.0.2",
|
||||
"marked": "~0.6.0",
|
||||
"mkdirp": "~0.5.1",
|
||||
"requizzle": "~0.2.1",
|
||||
"strip-json-comments": "~2.0.1",
|
||||
"@babel/parser": "^7.4.4",
|
||||
"bluebird": "^3.5.4",
|
||||
"catharsis": "^0.8.10",
|
||||
"escape-string-regexp": "^2.0.0",
|
||||
"js2xmlparser": "^4.0.0",
|
||||
"klaw": "^3.0.0",
|
||||
"markdown-it": "^8.4.2",
|
||||
"markdown-it-anchor": "^5.0.2",
|
||||
"marked": "^0.6.2",
|
||||
"mkdirp": "^0.5.1",
|
||||
"requizzle": "^0.2.2",
|
||||
"strip-json-comments": "^3.0.1",
|
||||
"taffydb": "2.6.2",
|
||||
"underscore": "~1.9.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"ajv": "~6.7.0",
|
||||
"gulp": "~4.0.0",
|
||||
"gulp-eslint": "~5.0.0",
|
||||
"gulp-json-editor": "~2.5.0",
|
||||
"nyc": "~13.1.0"
|
||||
"ajv": "^6.10.0",
|
||||
"gulp": "^4.0.1",
|
||||
"gulp-eslint": "^5.0.0",
|
||||
"gulp-json-editor": "^2.5.2",
|
||||
"nyc": "^14.1.0"
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=8.15.0"
|
||||
@ -42,18 +45,24 @@
|
||||
"jsdoc": "./jsdoc.js"
|
||||
},
|
||||
"greenkeeper": {
|
||||
"ignore": ["taffydb"]
|
||||
"ignore": [
|
||||
"taffydb"
|
||||
]
|
||||
},
|
||||
"bugs": "https://github.com/jsdoc3/jsdoc/issues",
|
||||
"bugs": "https://github.com/jsdoc/jsdoc/issues",
|
||||
"author": {
|
||||
"name": "Michael Mathews",
|
||||
"email": "micmath@gmail.com"
|
||||
},
|
||||
"contributors": [{
|
||||
"url": "https://github.com/jsdoc3/jsdoc/graphs/contributors"
|
||||
}],
|
||||
"maintainers": [{
|
||||
"name": "Jeff Williams",
|
||||
"email": "jeffrey.l.williams@gmail.com"
|
||||
}]
|
||||
"contributors": [
|
||||
{
|
||||
"url": "https://github.com/jsdoc/jsdoc/graphs/contributors"
|
||||
}
|
||||
],
|
||||
"maintainers": [
|
||||
{
|
||||
"name": "Jeff Williams",
|
||||
"email": "jeffrey.l.williams@gmail.com"
|
||||
}
|
||||
]
|
||||
}
|
||||
|
||||
@ -29,7 +29,7 @@
|
||||
<br class="clear">
|
||||
|
||||
<footer>
|
||||
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc <?js= env.version.number ?></a><?js if(env.conf.templates && env.conf.templates.default && env.conf.templates.default.includeDate !== false) { ?> on <?js= (new Date()) ?><?js } ?>
|
||||
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc <?js= env.version.number ?></a><?js if(env.conf.templates && env.conf.templates.default && env.conf.templates.default.includeDate !== false) { ?> on <?js= (new Date()) ?><?js } ?>
|
||||
</footer>
|
||||
|
||||
<script> prettyPrint(); </script>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user