javascript - JSDoc: How do I document the "options" object literal for a parent "class"?

Question

(This question already has answers here): question from:https://stackoverflow.com/questions/10683430/jsdoc-how-do-i-document-the-options-object-literal-for-a-parent-class

Answer 1

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    A person's name
 * @param {String} options.feature A person's property
 */
function flatter (options) {
  options = options || {};
  console.log('%s, loving your %s!', options.name, options.feature);
}