From 57e732be4e349470fad3e3cc44d96bf0746a598b Mon Sep 17 00:00:00 2001 From: Milos Djermanovic Date: Tue, 3 May 2022 02:33:10 +0200 Subject: [PATCH] docs: mark `SourceCode#getJSDocComment` deprecated in working-with-rules (#15829) --- docs/src/developer-guide/working-with-rules.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/developer-guide/working-with-rules.md b/docs/src/developer-guide/working-with-rules.md index 0a2d202cf98..e8d5a22bfda 100644 --- a/docs/src/developer-guide/working-with-rules.md +++ b/docs/src/developer-guide/working-with-rules.md @@ -541,7 +541,6 @@ Once you have an instance of `SourceCode`, you can use the following methods on * `getCommentsBefore(nodeOrToken)` - returns an array of comment tokens that occur directly before the given node or token. * `getCommentsAfter(nodeOrToken)` - returns an array of comment tokens that occur directly after the given node or token. * `getCommentsInside(node)` - returns an array of all comment tokens inside a given node. -* `getJSDocComment(node)` - returns the JSDoc comment for a given node or `null` if there is none. * `isSpaceBetween(nodeOrToken, nodeOrToken)` - returns true if there is a whitespace character between the two tokens or, if given a node, the last token of the first node and the first token of the second node. * `getFirstToken(node, skipOptions)` - returns the first token representing the given node. * `getFirstTokens(node, countOptions)` - returns the first `count` tokens representing the given node. @@ -598,6 +597,7 @@ Please note that the following methods have been deprecated and will be removed * `getTokenOrCommentBefore()` - replaced by `getTokenBefore()` with the `{ includeComments: true }` option * `getTokenOrCommentAfter()` - replaced by `getTokenAfter()` with the `{ includeComments: true }` option * `isSpaceBetweenTokens()` - replaced by `isSpaceBetween()` +* `getJSDocComment()` ### Options Schemas