← Back

jsdoc/tag-lines warning

Enforces a consistent padding of the block description.

Examples

❌  Incorrect

/**
 * Foo.
 *
 * Foo.
 * @foo
 */
function quux1 () {

}
// Message: There must be a newline after the description of the JSDoc block.

/**
 * Foo.
 * @foo
 *
 * Foo.
 */
function quux2 () {

}
// Message: There must be a newline after the description of the JSDoc block.

/**
 * Foo.
 *
 * Foo.
 * @foo
 */
function quux3 () {

}
// Message: There must be a newline after the description of the JSDoc block.

✅  Correct

/**
 * Foo.
 */
function quux1 () {

}

/**
 * Foo.
 *
 * @foo
 */
function quux2 () {

}