canonical/node_modules/jscs-jsdoc/lib/rules/validate-jsdoc/require-return-description.js

Canonical code style linter and formatter for JavaScript, SCSS and CSS.

module.exports = validateReturnTagDescription;
module.exports.tags = ['return', 'returns'];
module.exports.scopes = ['function'];
module.exports.options = {
    requireReturnDescription: {allowedValues: [true]}
};

/**
 * Validator for @return description.
 *
 * @param {(FunctionDeclaration|FunctionExpression)} node
 * @param {DocTag} tag
 * @param {Function} err
 */
function validateReturnTagDescription(node, tag, err) {
    // Check tag existence. Note: for @returns tag, description is parsed as a name.
    if (tag.name) {
        return;
    }

    return err('Missing return description', tag.loc);
}