Home

Table of Contents

  1. Getting Started
  2. JSDoc Examples
  3. Contribute
  4. JSDoc 3 Tag Dictionary

Getting Started

README
Basic info on JSDoc 3.
An introduction to JSDoc 3
A quick-start to documenting JavaScript with JSDoc.
Using namepaths with JSDoc 3.
A guide to using namepaths with JSDoc 3.
Tutorials mechanism
Additional longtext tutorials for your code.
Adding Content to Index.html
Using Readme files to add content to the default index.html
Command-line options to JSDoc 3
About the command-line options JSDoc supports.
Configuring JSDoc 3 with conf.json
How to configure JSDoc’s output with a configuration file.
Linking using inline tags
All about inline tags @link, @linkplain, @linkcode, @tutorial.
All about plugins
Installing plugins and writing your own.
Configuring the markdown plugin
This allows markdown in code comments and offers 2 flavors.
Testing JSDoc 3
About running the self tests included with JSDoc 3.
License
The license covering JSDoc 3 code.

JSDoc Examples

CommonJS Modules
Documenting code that conforms to the CommonJS server-side modules standard.

Contribute

JSDoc 3 at github
Contribute to the JSDoc 3 project.
JSDoc 3 Documentation
Contribute to the JSDoc 3 Documentation project.