For a function like this... function example() { var X = 100; ... var Y = 'abc'; ... return Z; } I need to explain the purpose of some of the local variables. Adding a description like ...

I have an array of array of string and I can't figure out how to document that with JSDoc. /** @class */ function PostbackList() { /** @type {int} @default */ this.TypeID = 0; /** @type {Po...

I've spent quite a while scouring the internet looking for the best way to properly document callbacks with jsdoc, but unfortunately, I haven't found a great one yet. Here's my question: I'm writ...

I am new to using JSDocs and couldn't find an answer to this question. Suppose I wanted to write this simple function: function hasQ(array, item) {return array.includes(item);} which with JSDoc...

I'm trying to use JSDoc in my ES6 project, I'm returning a Map: /** * Some documentation.. * * @returns {undefined} <- This should be replaced */ function returningMap() { const someMap =...

I have a javascript function that returns a constructor (see code sample below). How would I document this with the @returns tag of jsdoc. It doesnt seem correct to do @returns {MyConstructor} beca...

I am using JSDoc for parameter documentation. It is clear how to document the parameter types for many_prompts, but what is the right way to document the function it returns? /** * @param {Numbe...

Is it possible to use an enum for the JSDoc @param type declaration like in the following example? /** * @enum { Number } */ const TYPES = { TYPE_A: 1, TYPE_B: 2 } /** * @param { TYPES } type...

I'm connecting to multiple email tools and abstracting their APIs to one common sendEmail function with the same params and same returns for each service. That means that for every email service (M...

Short version: If I wanted to develop a completely new jsDoc template from scratch, what would I have to read to understand what jsDoc does, what interface my template must provide and what data I ...

I just need to run jsdoc on ai whole directory containing .js files, I am doing this on individual files in ubuntu terminal by issuing command jsdoc abc.js but what I need is to apply this command ...

The JSDoc docs say Copying a directory of images to the output directory. To copy all of the static files in ./myproject/static to the output directory: "default": { "staticFiles&...

I have the following project structure: api/ users/ users.d.js contexts/ users/ users.d.js utils/ users/ users.d.js In utils/users/users.d.js I am defining the types that are reusable thro...

Can I get in editor autocomplete for my functions using JSDoc somehow? I am creating a big google spreadsheet with a lot of code in the associated script editor. I get autocompletion help when I ...

I'd like know if it's possible to link from one module to another module`s property/method. What I've tried so far but wasn't working: /** * {@link module:modules/modulName#id} */ My modules ...

I'm trying to JSDoc a simple React Typescript component with hooks. Unfortunately, I can't seem to find a way that makes JSDoc work with declared destructured arrays. There are some answers related...

What's the easiest way to cause JsDoc to leave out the source links? Do I have to define my own template?

The JSDoc api says you can document objects like so: {Object.<string, number>} and document multiple type: {(number|boolean)} But if I try to specify an object that could have strings OR nu...

I have a large, well-structured JavaScript object that is something like this: /** * My 'class' begins here. JSDoc barfs on this. */ var MyClass = (function(window, document, $) { return funct...

I am documenting my code using jsdoc, so far so good, I have a comment like below ... * @property {string} mode - mode of display 'video' - display video or 'audio' - play only the audio. * @prope...

Assuming I have a typedef type in a js module // somewhere/foo.js /** * @module */ /** * @typedef Foo * @type {object} * property {string} bar - some property */ Is it possible to referen...

I have tons of json schema for node.js project. Can I use them in any way for: Accessing them as jsdoc types from ".js" code files to increase webstorm intellisense accuracy Or for creating jsdoc...

Just making sure that this in a module in our Node server is the right way to be able to use an @typedef throughout the application instead of repeating it in every module/file it is needed. From t...

This is a similar to question 30360391. I want to express that the parameter of a function is a plain JS object that can have arbitrary properties (with unknown) names but all properties are object...

We're using JSDOC to document our client-facing SDK and we're having difficult getting it to recognize our 'enums' (i.e. constants). Which tags should we use to get JSDOC to pick it up in the docum...