Skip to content

Commit 57e732b

Browse files
authored
docs: mark SourceCode#getJSDocComment deprecated in working-with-rules (#15829)
1 parent 9a90abf commit 57e732b

1 file changed

Lines changed: 1 addition & 1 deletion

File tree

docs/src/developer-guide/working-with-rules.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -541,7 +541,6 @@ Once you have an instance of `SourceCode`, you can use the following methods on
541541
* `getCommentsBefore(nodeOrToken)` - returns an array of comment tokens that occur directly before the given node or token.
542542
* `getCommentsAfter(nodeOrToken)` - returns an array of comment tokens that occur directly after the given node or token.
543543
* `getCommentsInside(node)` - returns an array of all comment tokens inside a given node.
544-
* `getJSDocComment(node)` - returns the JSDoc comment for a given node or `null` if there is none.
545544
* `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.
546545
* `getFirstToken(node, skipOptions)` - returns the first token representing the given node.
547546
* `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
598597
* `getTokenOrCommentBefore()` - replaced by `getTokenBefore()` with the `{ includeComments: true }` option
599598
* `getTokenOrCommentAfter()` - replaced by `getTokenAfter()` with the `{ includeComments: true }` option
600599
* `isSpaceBetweenTokens()` - replaced by `isSpaceBetween()`
600+
* `getJSDocComment()`
601601

602602
### Options Schemas
603603

0 commit comments

Comments
 (0)