Skip to content
Advertisement

PhpDocs: Possible to link method in parameter description?

Is it possible to link to another method/class/property/etc. inside my project inline inside the @deprecated tag? Like this:

JavaScript

?

Advertisement

Answer

According to PHPdoc.org, you could use the @see tag for that.

JavaScript

Also, PHPdoc.org recommends to use @see in case of a @deprecated method:

It is RECOMMENDED (but not required) to provide an additional description stating why the associated element is deprecated. If it is superceded by another method it is RECOMMENDED to add a @see tag in the same PHPDoc pointing to the new element.

User contributions licensed under: CC BY-SA
1 People found this is helpful
Advertisement