JarCasting
JarCasting JarCasting

jsdoc

WebJar for jsdoc

License

License
GroupId

GroupId

org.webjars.bower
ArtifactId

ArtifactId

jsdoc
Last Version

Last Version

3.4.0
Release Date

Release Date
Type

Type

jar
Description

Description

jsdoc
WebJar for jsdoc
Project URL

Project URL

http://webjars.org
Source Code Management

Source Code Management

https://github.com/jsdoc3/jsdoc

Download jsdoc

Filename Size
jsdoc-3.4.0.pom
jsdoc-3.4.0.jar 791 KB
jsdoc-3.4.0-sources.jar 22 bytes
jsdoc-3.4.0-javadoc.jar 22 bytes
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/org.webjars.bower/jsdoc/ -->
<dependency>
    <groupId>org.webjars.bower</groupId>
    <artifactId>jsdoc</artifactId>
    <version>3.4.0</version>
</dependency>
// https://jarcasting.com/artifacts/org.webjars.bower/jsdoc/
implementation 'org.webjars.bower:jsdoc:3.4.0'
// https://jarcasting.com/artifacts/org.webjars.bower/jsdoc/
implementation ("org.webjars.bower:jsdoc:3.4.0")
'org.webjars.bower:jsdoc:jar:3.4.0'
<dependency org="org.webjars.bower" name="jsdoc" rev="3.4.0">
  <artifact name="jsdoc" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.bower', module='jsdoc', version='3.4.0')
)
libraryDependencies += "org.webjars.bower" % "jsdoc" % "3.4.0"
[org.webjars.bower/jsdoc "3.4.0"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

JSDoc

Build Status

An API documentation generator for JavaScript.

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.

To install the latest version on npm globally (might require sudo; learn how to fix this):

npm install -g jsdoc

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.6.3). We recommend using the tilde operator instead (for example, ~3.6.3), which limits updates to the most recent patch-level version. See this Stack Overflow answer for more information about the caret and tilde operators.

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

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.

Run jsdoc --help for a complete list of command-line options.

Templates and tools

The JSDoc community has created templates and other tools to help you generate and customize your documentation. Here are a few of them:

Templates

Build tools

Other tools

For more information

License

JSDoc is copyright (c) 2011-present Michael Mathews micmath@gmail.com and the contributors to JSDoc.

JSDoc is free software, licensed under the Apache License, Version 2.0. See the LICENSE file for more details.

org.webjars.bower

JSDoc3

Versions

Version
3.4.0