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/

279 questions
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…
Andras Gyomrey
  • 1,552
  • 11
  • 33
0
votes
1 answer

Is there an Implements or Extends annotation in JSDoc?

I know there is an abstract annotation, so I was expecting an annotation for the inverse. Ie a sub-type method that implements (or extends) and abstract method. I can't seem to find any in the JSDoc reference.
Oliver Watkins
  • 10,301
  • 19
  • 83
  • 168
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
  • 560
  • 8
  • 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,047
  • 9
  • 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
  • 38,416
  • 12
  • 90
  • 126
-1
votes
1 answer

JSDoc, documenting an dictionary with default entries

In typescript I can document a dictionary/map that has certain given entries but is still a dictionary/map (as you can add or remove entries) like this type Foo = { bar: number; moo: number; [key: string]: number; }; Is there a JSDoc…
gman
  • 83,286
  • 25
  • 191
  • 301
-1
votes
2 answers

JavaScript JSDoc running on an Angular project

I am working on an Angular 4 project which I build from the Angular CLI. Next I want to install JSDOC I did this following the instructions: - npm install -g jsdoc - npm install --save-dev jsdoc So, now I have it installed. My question is...what…
user8770372
-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
  • 10,414
  • 4
  • 49
  • 114
-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
  • 475
  • 4
  • 17
1 2 3
…
18
19