Stack Overflow
Stack Overflow

Questions tagged [jsdoc3]

JSDoc3 is an API documentation generator for JavaScript. It can be customised via a plugin mechanism and the output can be controlled via templates. It is written in Javascript and can be run with Node.js or Rhino.

JSDoc 3

JSDoc3 is an API documentation generator for JavaScript. It can be customised via a plugin mechanism and the output can be controlled via templates.

It is written in Javascript and can be run with Node.js or Rhino.

The tool can be found at https://github.com/jsdoc3/jsdoc

The documentation can be found at http://usejsdoc.org/

294 questions
12
votes
1 answer

The error message "There are no input files to process" from jsdoc

Jsdoc is installed locally ( npm install jsdoc ). I get the following error while trying to execute .\node_modules.bin\jsdoc --debug ./lib/JavaScriptSource.js Output: DEBUG: JSDoc 3.3.0-dev (Sun, 15 Jun 2014 18:39:52 GMT) …
TDreama
  • 420
  • 3
  • 8
11
votes
1 answer

create custom tags with jsdoc

I am trying to create custom tags in jsdoc 3.4.2. The config.json file is { "tags": { "allowUnknownTags": true, "dictionaries": ["jsdoc","closure"] }, "source": { "include": [ "app/" …
anjo
  • 315
  • 2
  • 7
  • 18
11
votes
5 answers

Is there a detailed documentation on how to create own jsdoc templates?

Short version: If I wanted to develop a completely new jsDoc template from scratch, what would I have to read to understand what jsDoc does, what interface my template must provide and what data I get to work with? Long version: I've been using…
codepearlex
  • 544
  • 4
  • 20
10
votes
1 answer

JSDoc is this how you mark a @typedef as @global?

Just making sure that this in a module in our Node server is the right way to be able to use an @typedef throughout the application instead of repeating it in every module/file it is needed. From the docs I can't determine if this is correct or…
mtpultz
  • 17,267
  • 22
  • 122
  • 201
10
votes
3 answers

JSDoc object methods with @method or @property?

JSDoc 3's documentation includes this example: /** * The complete Triforce, or one or more components of the Triforce. * @typedef {Object} WishGranter~Triforce * @property {boolean} hasCourage - Indicates whether the Courage component is…
djechlin
  • 59,258
  • 35
  • 162
  • 290
10
votes
2 answers

JSDoc UML Diagram

Question: I'm editing and using an open source javascript library that has JSDoc tags in its code. I was wondering if anyone knew of a JSDoc plugin that would allow me to generate a class diagram from the JSDoc tags. Edit I decided to try out…
theCrux
  • 101
  • 1
  • 6
9
votes
1 answer

AMD + Backbone + JSDoc3 best way to document

I'm looking for the best way to document my code, but I don't find anything. I've see others topics, including this, but there all doesn't resolve my problem. I have something like this: define([ 'backbone' ], function (Backbone) { /** …
Exos
  • 3,958
  • 2
  • 22
  • 30
9
votes
1 answer

jsdoc with node generates empty index.html

I used the following command to generate html from the javascript file. $> jsdoc --debug jquery.js $> open out/index.html Output of the command DEBUG: JSDoc 3.3.2 (Sat, 13 Jun 2015 22:20:28 GMT) DEBUG: Environment info:…
JKdevp
  • 91
  • 1
  • 4
9
votes
1 answer

JSDoc: What is a relationship between modules and namespaces

I faced a problem with understanding the purpose of namespaces and modules in a union. For example I have a class Game.utils.Matrix. I want to annotate Game as a namespace, utils as a module and Matrix as a class: /** * @namespace Game */ /** *…
aspirisen
  • 965
  • 13
  • 29
8
votes
1 answer

How to document array destructured parameter in JSDoc

Given the following code, how do I properly document that using the latest JSDoc? function docMe([foo, bar = null, baz = 1]) { /* */ } I have tried this: /** * @param {Array} options Array containing the options. * @param {HTMLElement}…
connexo
  • 53,704
  • 14
  • 91
  • 128
8
votes
3 answers

Grouping Functions In JSDoc Generated Documentation

I'm using documentationjs (which uses jsdoc under the hood) to handle the generation of docs for a lib I'm working on. My lib is written is ES6 and is fully functional, and at present the documentation generated is an alphabetical list of all the…
Undistraction
  • 42,754
  • 56
  • 195
  • 331
8
votes
1 answer

Jsdoc3 commenting object

Assuming I have some object, what the is way to comment it using jsdoc3? /** * Test object * @namespace test */ var test = { /** * Some defaults * @memberOf test */ defaults: { 'test1': 1, 'test2': 2 }, …
Max
  • 1,090
  • 10
  • 23
7
votes
3 answers

static class property not working with Babel

I am using JSDOC and all it supported npm plugins to create nice documentation. Getting hard time when jsdoc is running and parsing JSX file it always throws error as below near = sign SyntaxError: unknown: Unexpected token export default class…
Keysinnovation
  • 145
  • 1
  • 1
  • 9
6
votes
1 answer

How to write a JSDoc for an object with different types of keys?

The JSDoc api says you can document objects like so: {Object.} and document multiple type: {(number|boolean)} But if I try to specify an object that could have strings OR numbers as the key, it does not work. VSCode/JSDoc just…
AncientSwordRage
  • 7,086
  • 19
  • 90
  • 173
6
votes
0 answers

jsdoc comments for npm module not appearing in vscode

I have an issue with npm and jsdoc. This question is similar to, but not the same as: How do I get my npm module's JSdoc documentation for functions to show up in users' VScode? In my case, the jsdoc info will appear if install the code in a local…
Bob Dill
  • 1,000
  • 5
  • 13
1 2
3
…
19 20