Skip to content
Permalink
Browse files
Docs: add missing deprecation notices for jsdoc rules (#11171)
The rules were deprecated in the last release, but the deprecation notices in the documentation are not autogenerated.
  • Loading branch information
not-an-aardvark committed Dec 8, 2018
1 parent 83017a3 commit 617a2874ed085bca36ca289aac55e3b7f7ce937e
Showing with 4 additions and 0 deletions.
  1. +2 −0 docs/rules/require-jsdoc.md
  2. +2 −0 docs/rules/valid-jsdoc.md
@@ -1,5 +1,7 @@
# require JSDoc comments (require-jsdoc)

This rule was **deprecated** 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:

```js
@@ -1,5 +1,7 @@
# enforce valid JSDoc comments (valid-jsdoc)

This rule was **deprecated** 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:

```js

0 comments on commit 617a287

Please sign in to comment.