@deprecated tag MUST be explained

[lenaorobei]

Description

If classes/interfaces/functions/constants/class members are marked as @deprecated the description and @see tag must be provided.

Motivation behind the added @deprecated tag MUST be explained. @see tag MUST be used with reference to new implementation when code is deprecated and there is a new alternative.

Expected behavior

In PHPDoc blocs @deprecated tag must have description and following @see tag with reference.

Good example:

    /**
     * @var string
     * @deprecated 100.2.0 Useful description here.
     * @see /NameSpace/To/Implementation
     */
    protected $classMemberName;

Bad example:

    /**
     * @var string
     * @deprecated
     */
    protected $classMemberName;

[udovicic]

If classes/interfaces/functions/constants/class members are marked as @deprecated [...]

Considering that functions sniff is currently in development (see #54), should we omit that one for now, or implement either way?

[lenaorobei]

If you could create method in the helper class, I will ask @larsroettig to reuse it for functions formatting.

[larsroettig]

Hi, i implementiert a docblock parser. See my pull request Lena Orobei <notifications@github.com> schrieb am Di. 13. Aug. 2019 um 18:47:

If you could create method in the helper class, I will ask @larsroettig <https://github.com/larsroettig> to reuse it for functions formatting. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#131?email_source=notifications&email_token=ABILLGSDLSNNVL6YVU7A34TQELQQ7A5CNFSM4ILL6L42YY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD4GIMVQ#issuecomment-520914518>, or mute the thread <https://github.com/notifications/unsubscribe-auth/ABILLGS473DHKAYVNZPH2FLQELQQ7ANCNFSM4ILL6L4Q> .

-- Lars Röttig Certified PHP Engineer / Web Developer Magento Community Maintainer MAGENTO 2 CERTIFIED PROFESSIONAL DEVELOPER MAGENTO CERTIFIED DEVELOPER PLUS Zend Certified PHP Engineer Telefon +49 8031 2210 55 - 0 Telefax +49 8031 2210 55 - 22 l.roettig@techdivision.com TechDivision GmbH Spinnereiinsel 3a 83059 Kolbermoor www.techdivision.com Magento Gold Partner TYPO3 Gold Member Geschäftsführer: Josef und Stefan Willkommer, Tim Wagner Handelsregister Nr. HRB 17123, Amtsgericht Traunstein UStID gemäß § 27 a Umsatzsteuergesetz: DE249664276