Add missing descriptions to the DocBlocks for various functions in wp-admin/includes/taxonomy.php.

Also adds a few missing parameter descriptions.

Props ipm-frommen.
See #31008.

Built from https://develop.svn.wordpress.org/trunk@31293


git-svn-id: http://core.svn.wordpress.org/trunk@31274 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2015-01-29 11:34:22 +00:00
parent f3033f34c6
commit 0f20ecca9c
2 changed files with 13 additions and 10 deletions

View File

@ -29,7 +29,7 @@ function category_exists( $cat_name, $parent = null ) {
} }
/** /**
* {@internal Missing Short Description}} * Get category object for given ID and 'edit' filter context.
* *
* @since 2.0.0 * @since 2.0.0
* *
@ -43,7 +43,7 @@ function get_category_to_edit( $id ) {
} }
/** /**
* {@internal Missing Short Description}} * Add a new category to the database if it does not already exist.
* *
* @since 2.0.0 * @since 2.0.0
* *
@ -189,7 +189,7 @@ function wp_update_category($catarr) {
// //
/** /**
* {@internal Missing Short Description}} * Check whether a post tag with a given name exists.
* *
* @since 2.3.0 * @since 2.3.0
* *
@ -201,7 +201,7 @@ function tag_exists($tag_name) {
} }
/** /**
* {@internal Missing Short Description}} * Add a new tag to the database if it does not already exist.
* *
* @since 2.3.0 * @since 2.3.0
* *
@ -213,11 +213,12 @@ function wp_create_tag($tag_name) {
} }
/** /**
* {@internal Missing Short Description}} * Get comma-separated list of tags available to edit.
* *
* @since 2.3.0 * @since 2.3.0
* *
* @param int $post_id * @param int $post_id
* @param string $taxonomy Optional. The taxonomy for which to retrieve terms. Default 'post_tag'.
* @return string|bool|WP_Error * @return string|bool|WP_Error
*/ */
function get_tags_to_edit( $post_id, $taxonomy = 'post_tag' ) { function get_tags_to_edit( $post_id, $taxonomy = 'post_tag' ) {
@ -225,11 +226,12 @@ function get_tags_to_edit( $post_id, $taxonomy = 'post_tag' ) {
} }
/** /**
* {@internal Missing Short Description}} * Get comma-separated list of terms available to edit for the given post ID.
* *
* @since 2.8.0 * @since 2.8.0
* *
* @param int $post_id * @param int $post_id
* @param string $taxonomy Optional. The taxonomy for which to retrieve terms. Default 'post_tag'.
* @return string|bool|WP_Error * @return string|bool|WP_Error
*/ */
function get_terms_to_edit( $post_id, $taxonomy = 'post_tag' ) { function get_terms_to_edit( $post_id, $taxonomy = 'post_tag' ) {
@ -272,11 +274,12 @@ function get_terms_to_edit( $post_id, $taxonomy = 'post_tag' ) {
} }
/** /**
* {@internal Missing Short Description}} * Add a new term to the database if it does not already exist.
* *
* @since 2.8.0 * @since 2.8.0
* *
* @param int|string $tag_name * @param int|string $tag_name
* @param string $taxonomy Optional. The taxonomy for which to retrieve terms. Default 'post_tag'.
* @return array|WP_Error * @return array|WP_Error
*/ */
function wp_create_term($tag_name, $taxonomy = 'post_tag') { function wp_create_term($tag_name, $taxonomy = 'post_tag') {

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.2-alpha-31292'; $wp_version = '4.2-alpha-31293';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.