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
1
vote
1 answer

jsdoc how break/close a tag

I would like insert a description between two example /** *@method ChangeItem *@example *oMenu.ChangeItem("menu.enable_all",{enable:true}); *oMenu.ChangeItem("menu",label:"",icon:align:"after",text:ICO.arrow_down}}); * *If I write description here,…
kalvia80
  • 11
  • 4
1
vote
1 answer

Why does jsDoc not parse my comment that has no trailing code?

I added a new plugin to jsdoc, introducing a new tag: dictionary.defineTag("newtag", { mustHaveValue: false, canHaveType: false, canHaveName: true, onTagged: function(doclet, tag) { doclet.newtag = tag.value; doclet.kind =…
codepearlex
  • 544
  • 4
  • 20
1
vote
1 answer

jsdocs3 error 'Unexpected token ='

i always get this error message within my React JSX files: export default class applicationContainer extends React.Component { static propTypes = { params: React.PropTypes.any, route: React.PropTypes.any }; .... or…
KaiserKoenig
  • 35
  • 7
1
vote
0 answers

Documenting "Factory Constructor" classes using jsdoc

I have some classes which follow the "Factory Constructor" pattern. These are constructed by calling the factory, not using the new keyword. Example: /** * Example "Factory Constructor" class * @class */ function MyClass() { return /**…
harmic
  • 28,606
  • 5
  • 67
  • 91
1
vote
3 answers

JSDoc: How do I document `var self = this;`?

JSDoc is great at picking up on methods and properties defined on a class as long as you use the this keyword, e.g.: /** @class */ function Person(name) { /** This person's name */ this.name = name; /** Greet someone */ this.greet =…
Ken Bellows
  • 6,711
  • 13
  • 50
  • 78
1
vote
1 answer

How to get the link to the index page to appear

I have started using jsdoc with jaguarjs-jsdoc to generate documentation for my API using node. It is working quite well and I can even use a readme.md file to generate the index page but I can't seem to get the link to the index page to appear in…
Devman
  • 310
  • 2
  • 10
1
vote
2 answers

JSDOC and Revealing Module Pattern

I have functions which are return objects. I wish to put their jsdoc definitions to see their property and methods on webstorm intellisense. How do I have to write jsdoc of below functions? function MyOtherFunc() { return { a:'for eg string', b:12…
uzay95
  • 16,052
  • 31
  • 116
  • 182
1
vote
1 answer

JSDoc 3 fails with unclear message

I'm using JSdoc 3.3.3 to generate documentation. I got the below error message: Generating output files...org.mozilla.javascript.EcmaError: SyntaxError: Unterminated parenthetical (#1(Function)#201(Function)#53(Function)#17) I have…
Klaus Christiansen
  • 187
  • 2
  • 11
1
vote
1 answer

How to document ES6 class module with jsdoc3?

If I am developing a node module something-nifty which has the following directory structure: something-nifty/ lib/ plugins/ Plugin.cs index.js package.json And plugin.cs is defined as follows: "use strict"; /** *…
Lea Hayes
  • 62,536
  • 16
  • 62
  • 111
1
vote
0 answers

javascript class inheritance and visibility in WebStorm

I am using WebStorm as my IDE of choice and write a lot of JavaScript. Autocompletion is nice but in the case of JavaScript there are still... thins left to improve... This is at least what I experienced. For example There are two classes, A and…
Colja
  • 209
  • 1
  • 3
  • 11
1
vote
0 answers

Comment nested module class with JSDoc3

I'm dealing with a module pattern in WebStorm's live inspection that I'm trying to comment. And I don't want to use AMD/CJS. ; My = (window.My || {}); My.Module = (My.Module || {}); My.Module.MyClass = (/** * * @param {My.Module.MyAnotherClass}…
lsagetlethias
  • 328
  • 2
  • 14
1
vote
0 answers

What is the canonical pattern for exporting enums in a JavaScript module?

I want to know the canonical pattern for exporting enums from a JavaScript module using require and jsdoc. Existing examples and questions seem to only consider local private enums. My goal is to have the best quality documentation and…
Moby Disk
  • 3,761
  • 1
  • 19
  • 38
1
vote
0 answers

NGDOC - top-down hierarchy

I have a large AngularJS project which is documented with NGDOC. We have lots of forms, and specific directives can be included only in specific forms. This is now documented as dependencies - each directive has @requires…
Petr Osipov
  • 621
  • 6
  • 16
1
vote
0 answers

JSDoc - How to document methods of a prototype object

Based on my understanding of the naming inheritence in JSDoc, this should work defining @name User.format#name but it does not /** * @class * @classdesc Stores the logged in user's information. Handles user updates and includes helper * methods…
Maruf
  • 890
  • 3
  • 10
  • 21
1
vote
2 answers

Intellij Says "Unresolved variable or type" but it's defined using @name

This is ths code: /** * @name Me * @property {String} name * @property {Number} minVer * @property {Number} maxVer */ /** @type {Me} the moshe*/ var y; Why IntelliJ says that {Me} is not defined?
Aminadav Glickshtein
  • 23,232
  • 12
  • 77
  • 117
1 2 3
…
19 20