Changeset 30682

Timestamp:

12/01/2014 02:16:36 AM (10 years ago)

Author:

wonderboymusic

Message:

Improve various @param docs.

See #30224.

Location:

trunk/src

Files:

• wp-admin/includes/class-wp-filesystem-direct.php (modified) (1 diff)
• wp-admin/includes/class-wp-filesystem-ftpext.php (modified) (1 diff)
• wp-admin/includes/class-wp-filesystem-ssh2.php (modified) (3 diffs)
• wp-includes/general-template.php (modified) (1 diff)
• wp-includes/query.php (modified) (1 diff)

trunk/src/wp-admin/includes/class-wp-filesystem-direct.php

@@ -203 +203 @@
     /**
      * @param string $file
-     * @return string
+     * @return string|false
      */
     public function group($file) {

trunk/src/wp-admin/includes/class-wp-filesystem-ftpext.php

@@ -124 +124 @@
      * @param string $file
      * @param string $contents
-     * @param bool|string $mode
+     * @param bool|int $mode
      * @return bool
      */

trunk/src/wp-admin/includes/class-wp-filesystem-ssh2.php

@@ -170 +170 @@
      * @param string $file
      * @param string $contents
-     * @param int $mode
+     * @param bool|int $mode
      * @return bool
      */
@@ -201 +201 @@
     /**
      * @param string $file
-     * @param bool $group
+     * @param string $group
      * @param bool $recursive
      */
@@ -241 +241 @@
      * @since Unknown
      *
-     * @param string $file    Path to the file.
-     * @param bool   $owner   A user name or number.
-     * @param bool   $recursive Optional. If set True changes file owner recursivly. Defaults to False.
+     * @param string     $file    Path to the file.
+     * @param string|int $owner   A user name or number.
+     * @param bool       $recursive Optional. If set True changes file owner recursivly. Defaults to False.
      * @return bool|string Returns true on success or false on failure.
      */

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

@@ -2015 +2015 @@
  * @param int|WP_Post $post      WP_Post object or ID. Default is global $post object.
  * @param bool        $translate Whether to translate the time string. Default false.
- * @return false|string Formatted date string or Unix timestamp. False on failure.
+ * @return false|string|int Formatted date string or Unix timestamp. False on failure.
  */
 function get_post_time( $d = 'U', $gmt = false, $post = null, $translate = false ) {

trunk/src/wp-includes/query.php

@@ -177 +177 @@
  * @uses $wp_query
  *
- * @param int|string|array $attachment Attachment ID, title, slug, or array of such.
+ * @param int|string|array|object $attachment Attachment ID, title, slug, or array of such.
  * @return bool
  */