More complete and consistent @deprecated inline docs/tags

[Alphawolf]

Hey folks, I noticed some @deprecated inline docs were inconsistent and/or incorrect for various functions so I went and did the following things:

• Changed the @deprecated inline tag(s) to follow the new ​inline docs standard written last year
• Added version information if missing but known
• Added fourth parameter (what to use instead) to _deprecated_function() if missing but known
• More consistent wording throughout the @deprecated inline docs

Patch attached.

ps. First patch (AFAIR). :)

[Alphawolf]

Re-uploaded the patch with a few typos fixed.

[Alphawolf]

Re-upload with more incorrect data fixed. Sry. :)

[jdgrimes]

A few issues in 28806.3.diff​:

• A second closing parenthesis is missing on line 957 of /wp-admin/includes/deprecated.php.
• deactivate_sitewide_plugin() should be replaced with deactivate_plugin(), right now it is deprecated in favor of itself.
• Some coding standards fixes in /wp-includes/deprecated.php. E.g.: * @deprecated 2.8.0 Use the_author_meta('description') should be the_author_meta( 'description' )

[Alphawolf]

Fixed issues found by @jdgrimes

[Alphawolf]

Replying to jdgrimes:

• Some coding standards fixes in /wp-includes/deprecated.php. E.g.: * @deprecated 2.8.0 Use the_author_meta('description') should be the_author_meta( 'description' )

Some occurrences of _deprecated_function did not meet the coding standards it seems (while some did throughout the code), e.g.
_deprecated_function( __FUNCTION__, '2.8', 'get_the_author_meta(\'description\')' );
which (among others) I changed to
_deprecated_function( __FUNCTION__, '2.8', 'get_the_author_meta( \'description\' )' );

Or did you only refer to the doc blocks? :)

[jdgrimes]

Replying to Alphawolf:

Or did you only refer to the doc blocks? :)

Yes, that's what I was meaning. :)

[Alphawolf]

Replying to jdgrimes:

Replying to Alphawolf:

Or did you only refer to the doc blocks? :)

Yes, that's what I was meaning. :)

Okay, so ignore the different notations of _deprecated_function's fourth parameter with some having whitespaces while others don't? :)

[jdgrimes]

Replying to Alphawolf:

Okay, so ignore the different notations of _deprecated_function's fourth parameter with some having whitespaces while others don't? :)

Yeah, I wouldn't change them. Except, maybe if there are any where you are editing the other parameters as well, you might change those. Usually we try to avoid changing things just for coding standards unless we're making other changes around it. So if you're editing that line anyway, you can clean up the spacing, but otherwise they will generally want to leave it be.

[Alphawolf]

Replying to jdgrimes:

Yeah, I wouldn't change them. Except, maybe if there are any where you are editing the other parameters as well, you might change those. Usually we try to avoid changing things just for coding standards unless we're making other changes around it. So if you're editing that line anyway, you can clean up the spacing, but otherwise they will generally want to leave it be.

Alright, will leave them be unless I changed the lines anways. New patch incoming soon. :)

[Alphawolf]

To self: Don't touch lines of code just for the thrill of it.

[DrewAPicture]

This will likely span beyond 4.0.

[DrewAPicture]

In 33671:

Docs: Standardize @deprecated tag formatting and add missing DocBlocks to deprecated functions in wp-admin/includes/deprecated.php.

Opted not to use the multi-function DocBlock syntax in the name of not taking shortcuts in documentation for the sake of brevity.

Props Alphawolf for the initial patch.
See #28806

[DrewAPicture]

In 33673:

Docs: Standardize @deprecated tag formatting and add missing DocBlock summaries to deprecated functions in wp-includes/deprecated.php.

Props Alphawolf for the initial patch.
Props DrewAPicture.

See #28806.

[DrewAPicture]

In 33674:

Docs: Standardize @deprecated tag formatting for deprecated functions in wp-includes/pluggable-deprecated.php.

Props Alphawolf for the initial patch.
Props DrewAPicture.

See #28806.

[DrewAPicture]

In 33675:

Docs: Standardize @deprecated tag formatting for deprecated functions in wp-admin/includes/ms-deprecated.php.

Props Alphawolf for the initial patch
Props DrewAPicture

See #28806.

[DrewAPicture]

In 33676:

Docs: Standardize @deprecated tag formatting and add missing summaries to deprecated functions in wp-includes/ms-deprecated.php.

Props Alphawolf for the initial patch.
Props DrewAPicture

See #28806.

[DrewAPicture]

In 33677:

Docs: Standardize @deprecated tag formatting in the DocBlock for wp_xmlrpc_server::login_pass_ok().

Props Alphawolf.
See #28806.

[DrewAPicture]

In 33678:

Docs: Standardize @deprecated tag formatting in the DocBlock for WP_Object_Cache:reset().

Props Alphawolf.
See #28806.

[DrewAPicture]

In 33679:

Docs: Standardize @deprecated tag formatting in the DocBlocks for several wpdb methods.

Props Alphawolf.
See #28806.

[DrewAPicture]

In 33680:

Docs: Standardize @deprecated tag formatting in the DocBlock for the logIO() function.

Props Alphawolf.
Fixes #28806.

[DrewAPicture]

New tickets for new issues. @Alphawolf: Thanks for the initial work!