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
0
votes
1 answer

JSDoc3 with Dojo and AMD

I am trying to get my JS documentation right. I am using Dojo, and some other complicated framework built on top of it, I will spare the details. The point is that this framework is using AMD modules. I want my JSDoc to work. Here is what I have so…
Frederic Fortier
  • 750
  • 8
  • 21
0
votes
1 answer

jsdoc @callback operator in webstorm

I think I'm doing it the way it's explained in jsdoc3 documentation. My WebStorm is version 8.0.4 /** * This callback type is called `dbOpenCallback` and is displayed as a global symbol. * * @callback dbOpenCallback * @param {object} err *…
user732456
  • 2,638
  • 2
  • 35
  • 49
0
votes
1 answer

Nodejs invalid regexp

I run the following command: node_modules/.bin/jsdoc -r --destination /home/user/public_html/jsdoc-meta/ node_modules/jsdoc/ and this is what I get. I don't find the error in the regular…
András Gyömrey
  • 1,770
  • 1
  • 15
  • 36
0
votes
2 answers

JSDoc on Nodejs gives TypeError: undefined is not a function

I would like to generate automatic documentation for my javascript project using JSDoc running on Nodejs. I did the following: Installed Nodejs Installed jsdoc from nodejs as follows: npm install jsdoc Everything seemed to go well. Then, I run…
Kesty
  • 610
  • 9
  • 19
0
votes
1 answer

JSDoc3 - How to document sub-members of a class

I'm trying to document something similar to the following where baz1 and bazzed are properties contained in the bar and bar is a member of Foo /** * @class */ function Foo(){ this.bar = { /** * The baz function */ baz1:…
wharding28
  • 1,271
  • 11
  • 13
0
votes
1 answer

Declare a CommonJs module as a mixin (JsDoc)

I have multiple standalone modules who're just mixins used by classes. Basically, my syntax is exactly this: /** @mixin actions/actions */ var actions = module.exports; /** * Some method */ actions.foo = function () {}; The file is detected as…
Simon Boudrias
  • 42,953
  • 16
  • 99
  • 134
-1
votes
1 answer

JSDoc does not recognize ES6 Class

I installed JSDoc from apt on Ubuntu 20.04 using jsdoc-toolkit and it does not recognize my ES6 class. Why is this?
qwr
  • 9,525
  • 5
  • 58
  • 102
-1
votes
1 answer

Using Doxygen to output Javadoc

I am trying to generate Typescript definitions for the LibreOffice SDK, which uses Doxygen to generate its documentation. Currently, I am using Doxygen to output XML, and parsing the XML to generate the JsDoc comments. However, I find myself having…
Zev Spitz
  • 13,950
  • 6
  • 64
  • 136
-2
votes
1 answer

JSDoc via npm not parsing any comments

I've installed JSDoc and JSDoc 3 Tool from npm. npm install git+https://github.com/jsdoc3/jsdoc.git sudo apt-get install jsdoc-toolkit The software installed successfully, executed the command (jsdoc -r=doc file.js), and the folder with files was…
lakewood
  • 607
  • 1
  • 5
  • 21
1 2 3
…
19
20