Changeset 36069

Timestamp:

12/23/2015 06:30:09 AM (8 years ago)

Author:

johnbillion

Message:

Docs: Miscellaneous docblock corrections.

See #32246

Location:

trunk/src

Files:

• wp-admin/includes/credits.php (modified) (2 diffs)
• wp-includes/cache.php (modified) (2 diffs)
• wp-includes/class-walker-page.php (modified) (1 diff)
• wp-includes/class-wp-http-curl.php (modified) (1 diff)
• wp-includes/ms-functions.php (modified) (1 diff)
• wp-includes/post.php (modified) (1 diff)

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

@@ -49 +49 @@
  * @since 3.2.0
  *
- * @param string &$display_name The contributor's display name, passed by reference.
+ * @param string $display_name  The contributor's display name, passed by reference.
  * @param string $username      The contributor's username.
  * @param string $profiles      URL to the contributor's WordPress.org profile page.
@@ -63 +63 @@
  * @since 3.2.0
  *
- * @param string &$data External library data, passed by reference.
+ * @param string $data External library data, passed by reference.
  */
 function _wp_credits_build_object_link( &$data ) {

trunk/src/wp-includes/cache.php

@@ -113 +113 @@
  * @param bool        $force  Optional. Whether to force an update of the local cache from the persistent
  *                            cache. Default false.
- * @param bool        &$found Optional. Whether the key was found in the cache. Disambiguates a return of false,
+ * @param bool        $found  Optional. Whether the key was found in the cache. Disambiguates a return of false,
  *                            a storable value. Passed by reference. Default null.
  * @return bool|mixed False on failure to retrieve contents or the cache
@@ -535 +535 @@
      * @param string     $force  Optional. Unused. Whether to force a refetch rather than relying on the local
      *                           cache. Default false.
-     * @param bool       &$found Optional. Whether the key was found in the cache. Disambiguates a return of
+     * @param bool       $found  Optional. Whether the key was found in the cache. Disambiguates a return of
      *                           false, a storable value. Passed by reference. Default null.
      * @return false|mixed False on failure to retrieve contents or the cache contents on success.

trunk/src/wp-includes/class-walker-page.php

@@ -78 +78 @@
      * @param object $page         Page data object.
      * @param int    $depth        Depth of page. Used for padding.
+     * @param array  $args         Optional arguments.
      * @param int    $current_page Page ID.
-     * @param array  $args
      */
     public function start_el( &$output, $page, $depth = 0, $args = array(), $current_page = 0 ) {

trunk/src/wp-includes/class-wp-http-curl.php

@@ -327 +327 @@
      *
      * @param resource $handle  cURL handle.
-     * @param string   $headers cURL request headers.
+     * @param string   $data    cURL request body.
      * @return int Total bytes of data written.
      */

trunk/src/wp-includes/ms-functions.php

@@ -2155 +2155 @@
  * @since 2.8.5
  *
- * @param string URL
+ * @param string $url URL
  * @return string URL with https as the scheme
  */

trunk/src/wp-includes/post.php

@@ -4269 +4269 @@
  *
  * @param int   $page_id   Page ID.
- * @param array &$children Parent-children relations, passed by reference.
- * @param array &$result   Result, passed by reference.
+ * @param array $children  Parent-children relations, passed by reference.
+ * @param array $result    Result, passed by reference.
  */
 function _page_traverse_name( $page_id, &$children, &$result ){