Changeset 32047

Timestamp:

04/05/2015 05:07:54 PM (10 years ago)

Author:

DrewAPicture

Message:

Fix a variety of inline documentation syntactical issues in wp-includes/taxonomy.php.

See #31888.

File:

• trunk/src/wp-includes/taxonomy.php (modified) (7 diffs)

trunk/src/wp-includes/taxonomy.php

@@ -311 +311 @@
  *
  * @since 2.3.0
- * @since 4.2.0 Introduced 'show_in_quick_edit' parameter.
- * @uses $wp_taxonomies Inserts new taxonomy object into the list
- * @uses $wp Adds query vars
+ * @since 4.2.0 Introduced `show_in_quick_edit` argument.
+ *
+ * @global array $wp_taxonomies Registered taxonomies.
+ * @global WP    $wp            WP instance.
  *
  * @param string $taxonomy Taxonomy key, must not exceed 32 characters.
@@ -2611 +2612 @@
  * @since 2.3.0
  * @since 4.2.0 Added support for 'taxonomy', 'parent', and 'term_taxonomy_id' values of `$orderby`.
- *              Introduced `$parent` parameter.
+ *              Introduced `$parent` argument.
  *
  * @global wpdb $wpdb WordPress database abstraction object.
@@ -2780 +2781 @@
      * @param array $object_id_array Array of object IDs for which `$terms` were retrieved.
      * @param array $taxonomy_array  Array of taxonomies from which `$terms` were retrieved.
-     * @param array $args            An array of arguments for retrieving terms for the given object(s).
-     *                               See {@see wp_get_object_terms()} for details.
+     * @param array $args            An array of arguments for retrieving terms for the given
+     *                               object(s). See wp_get_object_terms() for details.
      */
     $terms = apply_filters( 'get_object_terms', $terms, $object_id_array, $taxonomy_array, $args );
@@ -4130 +4131 @@
  * Create a new term for a term_taxonomy item that currently shares its term with another term_taxonomy.
  *
+ * @ignore
  * @since 4.2.0
- * @access private
  *
  * @param int  $term_id          ID of the shared term.
  * @param int  $term_taxonomy_id ID of the term_taxonomy item to receive a new term.
- * @return int|WP_Error When the current term does not need to be split (or cannot be split on the current database
- *                      schema), `$term_id` is returned. When the term is successfully split, the new term_id is
- *                      returned. A `WP_Error` is returned for miscellaneous errors.
+ * @return int|WP_Error When the current term does not need to be split (or cannot be split on the current
+ *                      database schema), `$term_id` is returned. When the term is successfully split, the
+ *                      new term_id is returned. A WP_Error is returned for miscellaneous errors.
  */
 function _split_shared_term( $term_id, $term_taxonomy_id ) {
@@ -4228 +4229 @@
  * Check default categories when a term gets split to see if any of them need to be updated.
  *
+ * @ignore
  * @since 4.2.0
- * @access private
  *
  * @param int    $term_id          ID of the formerly shared term.
@@ -4251 +4252 @@
  * Check menu items when a term gets split to see if any of them need to be updated.
  *
+ * @ignore
  * @since 4.2.0
- * @access private
  *
  * @param int    $term_id          ID of the formerly shared term.
@@ -4306 +4307 @@
  * @param int    $old_term_id Term ID. This is the old, pre-split term ID.
  * @param string $taxonomy    Taxonomy that the term belongs to.
- * @return bool|int If a previously split term is found corresponding to the old term_id and taxonomy, the new term_id
- *                  will be returned. If no previously split term is found matching the parameters, returns false.
+ * @return bool|int If a previously split term is found corresponding to the old term_id and taxonomy,
+ *                  the new term_id will be returned. If no previously split term is found matching
+ *                  the parameters, returns false.
  */
 function wp_get_split_term( $old_term_id, $taxonomy ) {