How can I tell JSDoc about the structure of an object that is returned. I have found the @return {{field1: type, field2: type, ...}} description syntax and tried it:  /**  * Returns a coordinate from a given mouse or touch event  * @param  {TouchEven...
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 writing a Node.js library for developers....
I am working on an app wich will become quite huge in time. I have decided to use JsDoc3 and DocStrap to document all modules. Modules are defined via require.js and in some places they are nested up to 3 or 4 levels deep.  Untill now I understand th...
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 documentation? Here's a sample:  /** *...
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 objects themselves with fixed properties.  An example: The...
E.g. MyClass.js  /**  * @class  * @name module:Bar  * @param {number} a1  * @param {string} a2  */ function Bar(a1, a2){}   And, in another file:  /** @type module:Bar.constructor */ // made up syntax var Bar = require("./MyClass.js");   Re-d...
I want to know the canonical pattern for exporting enums from a JavaScript module using require and jsdoc.  Existing examples and questions seem to only consider local private enums.  My goal is to have the best quality documentation and intellisense...
Thanks to the answer found here:  https://stackoverflow.com/a/19336366/592495  My JavaScript documentation is well-organized and well-formatted. Each namespace is a "parent" of methods contained within. However, navigation is not quite as gra...
I'm looking for a tool to generate the documentation for JavaScript functions and properties even if there are no appropriately formatted comment blocks associated with those functions or properties (like Doxygen does).  This comparison between...
I have a function with an array of objects as parameter and would like to describe the parameter (including the properties of the objects in the array) using JSDOC like in this example:  /**  * @param {Array.<Object>} filter - array of filter o...

Tags

Recent Questions

Top Questions

Home Tags Terms of Service Privacy Policy DMCA Contact Us

©2020 All rights reserved.