jsdoc

When using a, ES2015 class as a type in JSDoc it does not appear to work correctly in files that import that class via a require statement. While working within the same file that the class was defined in, everything works as expected (shown below). While working within a different file the class appears to import correctly and show its constructor typing (shown below). But when I try to use the class for typing (As done in the first image) it no longer considers my class as a valid type. Here is the jsconfig I was using for this example { "compilerOptions": { "target": "es6", "module":

Here is my jsdoc declaration. How should I adjust it, so that MyNewType.logFirst property actually references logFirst function, which I've annotated below? // my-new-type.js /** * MyNewType definition * @typedef {Object} MyNewType * @property {function} logFirst * @property {function} logSecond */ /** * @param {number} first * @param {number} second * @returns MyNewType */ module.exports = (first, second) => { /** * logs first argument * @param {number} times */ function logFirst(times) { for (let i = 0; i < times; i++) { console.log(first); } } /** * logs second argument * @param {number}

I have a function with jsdoc comment that resembles the following in my code: /** * Foo function * @param {Object} [options] * @param {String} [options.foo] */ var foo = function (options) { if (!options) options = {}; var foo = options.foo || 'foo'; // ... }; My IDE, WebStorm, marks options.foo as an 'unresolved variable'. If I remove the jsdoc comment, the warning disappears. How do I document this function in a way that WebStorm gets the hint and no longer displays this warning? Things that I tried: Remove @param {String} [options.foo] @param {?String} [options.foo] @param {String} options

I am trying to automate a particular module in our JS library and am stuck at a point where I want to define a set of properties (lets say an object that goes as construction parameter of a class). /** * This function initiates world peace! * @constructor * @param {object} defaults - The options to initiate peace. * @param {number} defaults.issues - The number of issues being taken up. * @param {string} defaults.source - The name of the location where process starts. */ var WorldPeace = function (defaults) { // code here }; It is well and good had all properties of the construction was defined

While having the myTypes constant written somewhere in a file called my-component.js , like below: import React from 'react' import { View } from 'react-native' import PropTypes from 'prop-types' export const myTypes = { activeColor: PropTypes.string, color: PropTypes.string, fontFamily: PropTypes.string, fontSize: PropTypes.number, fontWeight: PropTypes.oneOfType([PropTypes.string, PropTypes.number]), height: PropTypes.number, icon: PropTypes.node, iconOverlay: PropTypes.node, marginBottom: PropTypes.number, marginLeft: PropTypes.number, marginRight: PropTypes.number, marginTop: PropTypes

I have been having a hard time getting the @borrows tag working in JSDoc. I have been trying to get the documentation from one function and us it as documentation for a second function. But I don't seem to be able to even get a simple example working! /** * This is the description for funcA */ var funcA = function() {}; /** * @borrows funcA as funcB */ var funcB = function() {}; I was expecting this to output documentation for both functions with both exactly the same. However only funcA is only has a description. The @borrows tag doesn't seem to work directly on a symbol, but only indirectly.

I am trying to add a customTag to jsdoc. I have created a file in the plugins directory like this: method.js exports.defineTags = function(dictionary) { dictionary.defineTag("methodHttp", { mustHaveValue: true, canHaveType: false, canHaveName: true, onTagged: function(doclet, tag) { doclet.methodHttp = tag.value; } }); }; Then I added to my conf.json : { "tags": { "allowUnknownTags": true }, "source": { "includePattern": ".+\\.js(doc)?$", "excludePattern": "(^|\\/|\\\\)_" }, "plugins": [ "plugins/method" ], "templates": { "cleverLinks": false, "monospaceLinks": false, "default": {