Changeset 30983

Timestamp:

12/20/2014 11:03:21 PM (10 years ago)

Author:

wonderboymusic

Message:

Correct the @param docs for arguments that are truthy/falsey.

See #30799.

Location:

trunk/src

Files:

• wp-admin/includes/template.php (modified) (1 diff)
• wp-includes/general-template.php (modified) (1 diff)
• wp-includes/load.php (modified) (1 diff)
• wp-includes/post-template.php (modified) (1 diff)
• wp-includes/query.php (modified) (1 diff)

trunk/src/wp-admin/includes/template.php

@@ -711 +711 @@
  * @since 0.71
  *
- * @param int $edit      Accepts 1|true for editing the date, 0|false for adding the date.
- * @param int $for_post  Accepts 1|true for applying the date to a post, 0|false for a comment.
- * @param int $tab_index The tabindex attribute to add. Default 0.
- * @param int $multi     Optional. Whether the additional fields and buttons should be added.
+ * @param int|bool $edit      Accepts 1|true for editing the date, 0|false for adding the date.
+ * @param int|bool $for_post  Accepts 1|true for applying the date to a post, 0|false for a comment.
+ * @param int      $tab_index The tabindex attribute to add. Default 0.
+ * @param int|bool $multi     Optional. Whether the additional fields and buttons should be added.
  *                            Default 0|false.
  */

trunk/src/wp-includes/general-template.php

@@ -1313 +1313 @@
  *     @type string     $after           Markup to append to the end of each link. Default empty.
  *     @type bool       $show_post_count Whether to display the post count alongside the link. Default false.
- *     @type bool       $echo            Whether to echo or return the links list. Default 1|true to echo.
+ *     @type bool|int   $echo            Whether to echo or return the links list. Default 1|true to echo.
  *     @type string     $order           Whether to use ascending or descending order. Accepts 'ASC', or 'DESC'.
  *                                       Default 'DESC'.

trunk/src/wp-includes/load.php

@@ -218 +218 @@
  * @since 0.71
  *
- * @global float $timestart Seconds from when timer_start() is called.
- * @global float $timeend   Seconds from when function is called.
- *
- * @param int $display   Whether to echo or return the results. Accepts 0|false for return,
- *                       1|true for echo. Default 0|false.
- * @param int $precision The number of digits from the right of the decimal to display.
- *                       Default 3.
+ * @global float   $timestart Seconds from when timer_start() is called.
+ * @global float   $timeend   Seconds from when function is called.
+ *
+ * @param int|bool $display   Whether to echo or return the results. Accepts 0|false for return,
+ *                            1|true for echo. Default 0|false.
+ * @param int      $precision The number of digits from the right of the decimal to display.
+ *                            Default 3.
  * @return string The "second.microsecond" finished time calculation. The number is formatted
  *                for human consumption, both localized and rounded.

trunk/src/wp-includes/post-template.php

@@ -1112 +1112 @@
  *     for additional arguments.
  *
- * @type string     $sort_column How to short the list of pages. Accepts post column names.
- *                               Default 'menu_order, post_title'.
- * @type string     $menu_class  Class to use for the div ID containing the page list. Default 'menu'.
- * @type bool       $echo        Whether to echo the list or return it. Accepts true (echo) or false (return).
- *                               Default true.
- * @type string     $link_before The HTML or text to prepend to $show_home text. Default empty.
- * @type string     $link_after  The HTML or text to append to $show_home text. Default empty.
- * @type int|string $show_home   Whether to display the link to the home page. Can just enter the text
- *                               you'd like shown for the home link. 1|true defaults to 'Home'.
+ * @type string          $sort_column How to short the list of pages. Accepts post column names.
+ *                                    Default 'menu_order, post_title'.
+ * @type string          $menu_class  Class to use for the div ID containing the page list. Default 'menu'.
+ * @type bool            $echo        Whether to echo the list or return it. Accepts true (echo) or false (return).
+ *                                    Default true.
+ * @type string          $link_before The HTML or text to prepend to $show_home text. Default empty.
+ * @type string          $link_after  The HTML or text to append to $show_home text. Default empty.
+ * @type int|bool|string $show_home   Whether to display the link to the home page. Can just enter the text
+ *                                    you'd like shown for the home link. 1|true defaults to 'Home'.
  * }
  * @return string html menu

trunk/src/wp-includes/query.php

@@ -1473 +1473 @@
      *                                                 Default all fields. Accepts 'ids', 'id=>parent'.
      *     @type int          $hour                    Hour of the day. Default empty. Accepts numbers 0-23.
-     *     @type bool         $ignore_sticky_posts     Whether to ignore sticky posts or not. Setting this to false
+     *     @type int|bool     $ignore_sticky_posts     Whether to ignore sticky posts or not. Setting this to false
      *                                                 excludes stickies from 'post__in'. Accepts 1|true, 0|false.
      *                                                 Default 0|false.