require-jsdoc.js 917 B

1234567891011121314151617181920212223242526272829303132
  1. /* This Source Code Form is subject to the terms of the Mozilla Public
  2. * License, v. 2.0. If a copy of the MPL was not distributed with this
  3. * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
  4. "use strict";
  5. module.exports = {
  6. plugins: ["jsdoc"],
  7. rules: {
  8. "jsdoc/require-jsdoc": [
  9. "error",
  10. {
  11. require: {
  12. ClassDeclaration: true,
  13. FunctionDeclaration: false,
  14. },
  15. },
  16. ],
  17. "jsdoc/require-param": "error",
  18. "jsdoc/require-param-description": "error",
  19. "jsdoc/require-param-name": "error",
  20. "jsdoc/require-property": "error",
  21. "jsdoc/require-property-description": "error",
  22. "jsdoc/require-property-name": "error",
  23. "jsdoc/require-property-type": "error",
  24. "jsdoc/require-returns": "error",
  25. "jsdoc/require-returns-check": "error",
  26. "jsdoc/require-yields": "error",
  27. "jsdoc/require-yields-check": "error",
  28. },
  29. };