Changeset 21241

Timestamp:

07/09/2012 05:03:53 AM (12 years ago)

Author:

markjaquith

Message:

Bunch of PHPDoc corrections and cleanups. props c3mdigital. props SergeyBiryukov. fixes #21149

Location:

trunk/wp-includes

Files:

• bookmark-template.php (modified) (2 diffs)
• class-http.php (modified) (1 diff)
• formatting.php (modified) (7 diffs)
• general-template.php (modified) (2 diffs)

trunk/wp-includes/bookmark-template.php

@@ -43 +43 @@
  * @since 2.1.0
  * @access private
- * @usedby wp_list_bookmarks()
  *
  * @param array $bookmarks List of bookmarks to traverse
@@ -190 +189 @@
  *
  * @since 2.1.0
- * @uses _list_bookmarks() Used to iterate over all of the bookmarks and return
+ * @uses _walk_bookmarks() Used to iterate over all of the bookmarks and return
  *      the html
  * @uses get_terms() Gets all of the categories that are for links.

trunk/wp-includes/class-http.php

@@ -201 +201 @@
      * @param string $url URL to Request
      *
-     * @return string|false Class name for the first transport that claims to support the request. False if no transport claims to support the request.
+     * @return string|bool Class name for the first transport that claims to support the request. False if no transport claims to support the request.
      */
     public function _get_first_available_transport( $args, $url = null ) {

trunk/wp-includes/formatting.php

@@ -101 +101 @@
 
     // Transform into regexp sub-expression used in _wptexturize_pushpop_element
-    // Must do this everytime in case plugins use these filters in a context sensitive manner
+    // Must do this every time in case plugins use these filters in a context sensitive manner
     $no_texturize_tags = '(' . implode('|', apply_filters('no_texturize_tags', $default_no_texturize_tags) ) . ')';
     $no_texturize_shortcodes = '(' . implode('|', apply_filters('no_texturize_shortcodes', $default_no_texturize_shortcodes) ) . ')';
@@ -142 +142 @@
  * @param string $disabled_elements Tags to match against formatted as regexp sub-expression
  * @param string $opening Tag opening character, assumed to be 1 character long
- * @param string $opening Tag closing  character
- * @return object
+ * @param string $closing Tag closing character
  */
 function _wptexturize_pushpop_element($text, &$stack, $disabled_elements, $opening = '<', $closing = '>') {
@@ -265 +264 @@
  * @access private
  * @param array $matches preg_replace_callback matches array
- * @returns string
+ * @return string
  */
 function _autop_newline_preservation_helper( $matches ) {
@@ -1010 +1009 @@
  *
  * @param string $orderby Order by string to be checked.
- * @return string|false Returns the order by clause if it is a match, false otherwise.
+ * @return string|bool Returns the order by clause if it is a match, false otherwise.
  */
 function sanitize_sql_orderby( $orderby ){
@@ -1624 +1623 @@
  * @access private
  *
- * @param string $string The string to split
- * @param    int $goal   The desired chunk length.
+ * @param string $string The string to split.
+ * @param int $goal The desired chunk length.
  * @return array Numeric array of chunks.
  */
@@ -1823 +1822 @@
  *
  * @since 1.2.0
- * @usedby wp_mail() handles charsets in email subjects
  *
  * @param string $string Subject line
@@ -1840 +1838 @@
 
 /**
- * Helper function to convert hex encoded chars to ascii
+ * Helper function to convert hex encoded chars to ASCII
  *
  * @since 3.1.0
  * @access private
- * @param array $match the preg_replace_callback matches array
+ * @param array $match The preg_replace_callback matches array
+ * @return array Converted chars
  */
 function _wp_iso_convert( $match ) {

trunk/wp-includes/general-template.php

@@ -1051 +1051 @@
  *
  * @since 1.5.0
- * @usedby get_calendar()
  *
  * @param int $num Number of day.
@@ -1068 +1067 @@
  *
  * @since 1.0.0
+ * @uses calendar_week_mod()
  *
  * @param bool $initial Optional, default is true. Use initial calendar names.