Skip to content
Permalink
Browse files
Docs: link to JSDoc EOL blogpost in valid-jsdoc and require-jsdoc (#1…
  • Loading branch information
ibbignerd authored and not-an-aardvark committed Dec 13, 2018
1 parent d5eb108 commit 733d93618a99758a05453ab94505a9f1330950e0
Showing with 2 additions and 2 deletions.
  1. +1 −1 docs/rules/require-jsdoc.md
  2. +1 −1 docs/rules/valid-jsdoc.md
@@ -1,6 +1,6 @@
# require JSDoc comments (require-jsdoc)

This rule was **deprecated** in ESLint v5.10.0.
This rule was [**deprecated**](https://eslint.org/blog/2018/11/jsdoc-end-of-life) in ESLint v5.10.0.

[JSDoc](http://usejsdoc.org) is a JavaScript API documentation generator. It uses specially-formatted comments inside of code to generate API documentation automatically. For example, this is what a JSDoc comment looks like for a function:

@@ -1,6 +1,6 @@
# enforce valid JSDoc comments (valid-jsdoc)

This rule was **deprecated** in ESLint v5.10.0.
This rule was [**deprecated**](https://eslint.org/blog/2018/11/jsdoc-end-of-life) in ESLint v5.10.0.

[JSDoc](http://usejsdoc.org) generates application programming interface (API) documentation from specially-formatted comments in JavaScript code. For example, this is a JSDoc comment for a function:

0 comments on commit 733d936

Please sign in to comment.