How do I document functions inside of a return?

Question

How do I document functions inside of a return? In this example, I need then() documented. I have tried adding @memberOf and @name to get it to generate. Nothing seems to work for me.

/**
 * The description for the outer function 
 * @param {string} test Example argument
 * @return {Object}
 */
example.func = function(test) {
   return {
       /**
        * The description for the inner "then" function
        * @param {Function} cb The callback function
        */
       then: function(cb) { }
   }
}

Update Added JSDoc comments to the top to prevent confusion.

Possible duplicate of JSDoc: Return object structure

Hitmands
– Hitmands

2016-12-09 21:57:21 +00:00
Commented Dec 9, 2016 at 21:57 — Hitmands
– Hitmands, Commented Dec 9, 2016 at 21:57

Hitmands · Accepted Answer · 2016-12-09 21:28:54Z

1

JSDoc comments must be above the declaration, the return statement must be declared with @returns {type} value (note that @return is a synonyms)

/**
 * Returns the sum of a and b
 *
 * @param {Number} a
 * @param {Number} [b = 0]
 * @returns {Number}
 */
function sum(a, b = 0) {
    return a + b;
}

answered Dec 9, 2016 at 21:28

Hitmands

14.2k4 gold badges41 silver badges78 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

Eric Harms Over a year ago

I'm trying to document a function inside a return - like a promise. The outside function had its own jsdoc comment but didn't include it inside de the example to make it concise.

Hitmands Over a year ago

If you are returning a Promise, you must do: @returns {Promise}.

Eric Harms Over a year ago

It's not a promise. I said like a promise. See the above code.

Hitmands Over a year ago

stackoverflow.com/questions/28763257/…

Collectives™ on Stack Overflow

How do I document functions inside of a return?

1 Answer 1

4 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

4 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related