Remove redundant and erroneous @uses tag from most core inline documentation.

Per our inline documentation standards, no further use of the `@uses` tag is recommended as used and used-by relationships can be derived through other means. This removes most uses of the tag in core documentation, with remaining tags to be converted to `@global` or `@see` as they apply.

Fixes #30191.


git-svn-id: https://develop.svn.wordpress.org/trunk@30105 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes (DrewAPicture)
2014-10-30 01:04:55 +00:00
parent e999d15f44
commit 3cc10d77a0
47 changed files with 0 additions and 365 deletions
-22
View File
@@ -17,8 +17,6 @@
*
* @since 1.5.0
*
* @uses locate_template()
*
* @param string $name The name of the specialised header.
*/
function get_header( $name = null ) {
@@ -59,8 +57,6 @@ function get_header( $name = null ) {
*
* @since 1.5.0
*
* @uses locate_template()
*
* @param string $name The name of the specialised footer.
*/
function get_footer( $name = null ) {
@@ -101,8 +97,6 @@ function get_footer( $name = null ) {
*
* @since 1.5.0
*
* @uses locate_template()
*
* @param string $name The name of the specialised sidebar.
*/
function get_sidebar( $name = null ) {
@@ -150,8 +144,6 @@ function get_sidebar( $name = null ) {
*
* @since 3.0.0
*
* @uses locate_template()
*
* @param string $slug The slug name for the generic template.
* @param string $name The name of the specialised template.
*/
@@ -307,9 +299,6 @@ function wp_loginout($redirect = '', $echo = true) {
*
* @since 2.7.0
*
* @uses wp_nonce_url() To protect against CSRF.
* @uses site_url() To generate the log out URL.
*
* @param string $redirect Path to redirect to on logout.
* @return string A log out URL.
*/
@@ -340,8 +329,6 @@ function wp_logout_url($redirect = '') {
*
* @since 2.7.0
*
* @uses site_url() To generate the log in URL.
*
* @param string $redirect Path to redirect to on login.
* @param bool $force_reauth Whether to force reauthorization, even if a cookie is present. Default is false.
* @return string A log in URL.
@@ -373,8 +360,6 @@ function wp_login_url($redirect = '', $force_reauth = false) {
*
* @since 3.6.0
*
* @uses site_url() To generate the registration URL.
*
* @return string User registration URL.
*/
function wp_registration_url() {
@@ -496,8 +481,6 @@ function wp_login_form( $args = array() ) {
*
* @since 2.8.0
*
* @uses site_url() To generate the lost password URL
*
* @param string $redirect Path to redirect to on login.
* @return string Lost password URL.
*/
@@ -1429,7 +1412,6 @@ function calendar_week_mod($num) {
* no posts for the month, then it will not be displayed.
*
* @since 1.0.0
* @uses calendar_week_mod()
*
* @param bool $initial Optional, default is true. Use initial calendar names.
* @param bool $echo Optional, default is true. Set to false for return.
@@ -1711,7 +1693,6 @@ function the_date_xml() {
*
* @since 0.71
*
* @uses get_the_date()
* @param string $d Optional. PHP date format defaults to the date_format option if not specified.
* @param string $before Optional. Output before the date.
* @param string $after Optional. Output after the date.
@@ -2032,7 +2013,6 @@ function get_post_modified_time( $d = 'U', $gmt = false, $post = null, $translat
*
* @since 0.71
* @uses $wp_locale
* @uses $post
*/
function the_weekday() {
global $wp_locale;
@@ -2358,7 +2338,6 @@ function wp_editor( $content, $editor_id, $settings = array() ) {
* to ensure that it is safe for placing in an html attribute.
*
* @since 2.3.0
* @uses esc_attr()
*
* @param bool $escaped Whether the result is escaped. Default true.
* Only use when you are later escaping it. Do not use unescaped.
@@ -2385,7 +2364,6 @@ function get_search_query( $escaped = true ) {
* The search query string is passed through {@link esc_attr()}
* to ensure that it is safe for placing in an html attribute.
*
* @uses esc_attr()
* @since 2.1.0
*/
function the_search_query() {