Top "Jsdoc" questions

JSDoc is a markup language for adding inline API documentation to JavaScript source code.

What is the proper/canonical formatting of long JSDoc lines?

All of the official JSDoc examples have naively simple documentation strings, like the following: /** * @param {string} author - The author …

jsdoc
How to reference a @class in another file with JSdoc?

E.g. MyClass.js /** * @class * @name module:Bar * @param {number} a1 * @param {string} a2 */ function Bar(a1, a2){} And, in …

javascript jsdoc jsdoc3
How to document resolved values of JavaScript promises

Given this code : function asyncFoo() { return new Promise(function (fulfill, reject) { doAsyncStuff(function(err, data) { if(err) reject(new Error(…

javascript jsdoc
What's the correct way to document a jQuery parameter type with JSDoc?

I'm trying to document my program with the JSDoc syntax for myself and the people that will have to look …

javascript jquery jsdoc
_Best Practices for JSDoc'ing Javascript files written in the "revealing module pattern" Style?

Most of my Javascript functions are relatively simple, and called for their sideeffects: I use jQuery to manipulate the DOM …

javascript eclipse documentation documentation-generation jsdoc
How do I refer to another typescript type in comments/JSDoc?

I'm familiar with Javadoc. In Javadoc, you can place a link that refers to the Javadoc placed on another type …

typescript visual-studio-code jsdoc
TypeScript jsdoc for interface properties

I have a TypeScript interface with a single-character property name (a design constraint). I would like to use JSDoc to …

typescript visual-studio-code jsdoc
Insert relative link in reStructuredText

I am documenting a library that has a Python component and a JavaScript component. The overall user documentation, and the …

documentation restructuredtext jsdoc
How to document return in JavaScript

I'm writing my own library for the project at work for a browser application and I am having the same …

javascript google-closure-compiler jsdoc code-documentation
How can I view the outline in eclipse when using the revealing module pattern?

I'm currently refactoring some Javascript code we have and amongst other things I've changed it to make use of the …

javascript eclipse jsdoc revealing-module-pattern