@deprecated
Table of Contents
Syntax
@deprecated [<some text>]
Overview
The @deprecated tag marks a symbol in your code as being deprecated.
Examples
You can use the @deprecated tag by itself, or include some text that describes more about the deprecation.
Document that the old function has been deprecated since version 2.0
/** * @deprecated since version 2.0 */ function old() { }
© 2011–2017 the contributors to the JSDoc 3 documentation project
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
https://jsdoc.app/tags-deprecated.html