CODEWITHSUNDEEP
javascriptnode.jsdoxygenjsdocjsdoc3
Ganesh K
Ganesh K

Reputation: 2703

JSDoc - specifying mandatory parameter syntax

I am using @JSDoc to create documentation for my javascript library. I know how to indicate optional parameter. like below

/*
 * @param {string} [somebody] - Somebody's name.
 */
function sayHello(somebody) {
    if (!somebody) {
        somebody = 'John Doe';
    }
    alert('Hello ' + somebody);
}

But I would like to indicate some parameters in my API are mandatory. How to indicate it using JSDOC. I don't find any from JSDoc tags-param

Upvotes: 6

Views: 7224

Answers (1)

Louis
Louis

Reputation: 151401

Unless you mark a parameter as optional, then the parameter is considered mandatory. There's nothing additional you need to do. To make your somebody parameter mandatory you'd just remove the brackets:

@param {string} somebody - Somebody's name.

Upvotes: 9

Related Questions