In the meantime, support for this feature has been finalized and is now documented on the Closure Compiler JSDOC page for generics. Basically it works like this for ES6 classes: /** @template T */ class Foo { /** @return {T} */ get() { … }; /** @param {T} t */ set(t) { … }; } … Read more
You sure can, though your mileage may vary. 1: A use of @link in Selenium-Webdriver’s TypeScript typing file /** * Converts a level name or value to a {@link logging.Level} value. * If the name/value is not recognized, {@link logging.Level.ALL} * will be returned. * @param {(number|string)} nameOrValue The log level name, or value, to … Read more
You can define types in a module (eg. typedefs.js). The module contains your JSDoc typedefs and can simply export an unused property. // typedefs.js /** * @typedef foo * @property {string} bar */ // etc. exports.unused = {}; // or export {}; To use it, import the module where you need to reference these typedefs: … Read more
To document instance members, use @name Class#member: /** * Construct a new component * * @class Component * @classdesc A generic component * * @param {Object} options – Options to initialize the component with * @param {String} options.name – This component’s name, sets {@link Component#name} * @param {Boolean} options.visible – Whether this component is visible, … Read more
I usually use something like the code below in my projects. function example() { /** * Need to explain the purpose of X here. * @type {number} */ var X = 100; … /** * Need to explain the purpose of Y here. * @type {string} */ var Y = ‘abc’; … return Z; }
If I understand your question correctly, you have a function that takes an options object and you want to document all of its members? A rough example of how to do that in JSDoc is as below: /** * @description * Compliment someone on their something. * * @param {Object} options * @param {String} options.name … Read more
CoffeeScript Input: ### define function variable before block to avoid code being appended to closing part of JSDoc comment ### cube = null ###* * Function to calculate cube of input * @param {number} Number to operate on * @return {number} Cube of input ### cube = (x) -> x*x*x JavaScript Output from windows cmd … Read more
You can use a combination of @module or @namespace along with @memberof. define([], function() { /** * A test module foo * @version 1.0 * @exports mystuff/foo * @namespace foo */ var foo = { /** * A method in first level, just for test * @memberof foo * @method testFirstLvl */ testFirstLvl: function(msg) {}, … Read more
This seems to be working for me. /** * @param {Number} count – number of times to prompt * @return {function(): void} – the returned function */ manyPrompts(count) { /** * My inner function * * @param {object} prompt Some parameter */ const inner = function(prompt) { for (let i=0; i < count; i++) { … Read more
You can use the | separator to specify multiple types in the method type signature: /** * Some method * @param {Object|string|number} param The parameter. * @returns {Object|string|number} The modified param. */ function doSomething(param) { return etc.. };