Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for @deprecated to @since xxxxxx replacement #130

Closed
raamdev opened this issue Jul 7, 2016 · 2 comments
Closed

Add support for @deprecated to @since xxxxxx replacement #130

raamdev opened this issue Jul 7, 2016 · 2 comments

Comments

@raamdev
Copy link
Contributor

raamdev commented Jul 7, 2016

The Phing replacement of @since 16xxxx worked well during the latest Comet Cache release, but there was an edge case that it missed:

@raamdev
Copy link
Contributor Author

raamdev commented Aug 20, 2016

@jaswsinc Any idea why it missed these lines? Sorry, I just realized these are @deprecated lines — 😴

@jaswrks
Copy link
Contributor

jaswrks commented Aug 23, 2016

The @deprecated tag is now supported. However, please note the following:

  • You must type it out where the version comes immediately after the @deprecated tag.

Examples

/**
 * @deprecated 16xxxx Whatever note you want to leave.
 * @deprecated xxxxxx This works too; i.e., with no numbers.
 * @since 16xxxxxxxx This works too; i.e., 2 numbers followed by 4 or more x's.
 * @since xxxxxxxxxx This works too; i.e., 6 or more x's.
 */

Suggested Alternative

The Phing build system also supports $v as a replacement code, and since that is shorter and easier to recognize as something that is going to be replaced automatically, that is what I suggest.

/**
 * @since      $v Whatever note you want to leave.
 * @deprecated $v Whatever note you want to leave.
 */

@jaswrks jaswrks closed this as completed Aug 23, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants