Top "Jsdoc3" questions

JSDoc3 is an API documentation generator for JavaScript.

JSDoc: Return object structure

How can I tell JSDoc about the structure of an object that is returned. I have found the @return {{field1: …

javascript documentation-generation jsdoc code-documentation jsdoc3
How do I JSDoc A Nested Object's Methods?

I've been trying to use JSDoc3 to generate documentation on a file, but I'm having some difficulty. The file (which …

javascript requirejs jsdoc jsdoc3
What's the proper way to document callbacks with jsdoc?

I've spent quite a while scouring the internet looking for the best way to properly document callbacks with jsdoc, but …

javascript node.js jsdoc autodoc jsdoc3
Enum as @param type in JSDoc

Is it possible to use an enum for the JSDoc @param type declaration like in the following example? /** * @enum { Number } */ …

javascript ide jsdoc jsdoc3
JSDoc with AngularJS

Currently within my Project we are using JSDoc, we have recently started to implement Angular and I want to continue …

angularjs jsdoc jsdoc3
How to document a function returned by a function using JSDoc

I am using JSDoc for parameter documentation. It is clear how to document the parameter types for many_prompts, but …

javascript jsdoc jsdoc3
JSDocs: Documenting Node.js express routes

I am struggling documenting router.get calls with JSDocs. I am unable to get the documentation to display correctly on …

node.js jsdoc jsdoc3
What is the correct JSDoc syntax for a local variable?

For a function like this... function example() { var X = 100; ... var Y = 'abc'; ... return Z; } I need to explain the purpose …

javascript jsdoc jsdoc3
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~…

javascript jsdoc jsdoc3
jsdoc : reference typedef-ed type from other module

Assuming I have a typedef type in a js module // somewhere/foo.js /** * @module */ /** * @typedef Foo * @type {object} * property {string} …

jsdoc jsdoc3