Changeset 29163

Timestamp:

07/14/2014 01:01:22 AM (6 years ago)

Author:

DrewAPicture

Message:

Inline documentation cleanup for 4.0 audit.

Various improvements:

• Adds @see reference for wp_list_comments() in 'wp_list_comments_args' filter docs, added in [28285]
• Various phpDoc tweaks for the 'run_wptexturize' filter docs, added in [28715]
• Sentence and wrapping changes for is_https_url(), added in [28894]
• Documents the $args parameter for wp_dropdown_languages(), added in [29007]
• Adds a period to the parameter description for _update_posts_count_on_delete(), added in [28835]
• Documents a global in is_customize_preview(), added in [28999]
• phpDoc tweaks, adds an access modifier for wpdb::esc_like(), added in [28711]

See #28885.

Location:

trunk/src/wp-includes

Files:

• comment-template.php (modified) (1 diff)
• formatting.php (modified) (1 diff)
• functions.php (modified) (1 diff)
• l10n.php (modified) (1 diff)
• ms-blogs.php (modified) (1 diff)
• theme.php (modified) (1 diff)
• wp-db.php (modified) (1 diff)

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

@@ -1940 +1940 @@
      *
      * @since 4.0.0
+     *
+     * @see wp_list_comments()
      *
      * @param array $r An array of arguments for displaying comments.

trunk/src/wp-includes/formatting.php

@@ -41 +41 @@
     if ( $reset || ! isset( $static_characters ) ) {
         /**
-         * Filter whether to skip running `wptexturize()`.
+         * Filter whether to skip running wptexturize().
          *
-         * Passing false to the filter will effectively short-circuit `wptexturize()`.
+         * Passing false to the filter will effectively short-circuit wptexturize().
          * returning the original text passed to the function instead.
          *
-         * The filter runs only once, the first time `wptexturize()` is called.
+         * The filter runs only once, the first time wptexturize() is called.
          *
          * @since 4.0.0
          *
-         * @param bool $run_texturize Whether to short-circuit `wptexturize()`.
+         * @see wptexturize()
+         *
+         * @param bool $run_texturize Whether to short-circuit wptexturize().
          */
         $run_texturize = apply_filters( 'run_wptexturize', $run_texturize );

trunk/src/wp-includes/functions.php

@@ -3507 +3507 @@
  * @since 4.0.0
  * 
- * @param  string  $url The URL
- * @return bool True if the given URL uses https, false if not (or if the URL is not valid).
+ * @param string $url The URL.
+ * @return bool True if the given URL uses https, false if not (or if the URL
+ *              is not valid).
  */
 function is_https_url( $url ) {

trunk/src/wp-includes/l10n.php

@@ -822 +822 @@
  *
  * @since 4.0.0
+ *
+ * @see get_available_languages()
+ *
+ * @param array $args Optional arguments. Default empty array.
  */
 function wp_dropdown_languages( $args = array() ) {

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

@@ -911 +911 @@
  * @since 4.0
  *
- * @param int $post_id Post ID
+ * @param int $post_id Post ID.
  */
 function _update_posts_count_on_delete( $post_id ) {

trunk/src/wp-includes/theme.php

@@ -1948 +1948 @@
  * @since 4.0.0
  *
+ * @global WP_Customize_Manager $wp_customize Customizer instance.
+ *
  * @return bool True if the site is being previewed in the Customizer, false otherwise.
  */

trunk/src/wp-includes/wp-db.php

@@ -1189 +1189 @@
      *
      * @since 4.0.0
-     *
-     * @param string $text The raw text to be escaped. The input typed by the user should have no extra or deleted slashes.
-     * @return string Text in the form of a LIKE phrase. The output is not SQL safe. Call prepare or real_escape next.
-     */
-    function esc_like( $text ) {
+     * @access public
+     *
+     * @param string $text The raw text to be escaped. The input typed by the user should have no
+     *                     extra or deleted slashes.
+     * @return string Text in the form of a LIKE phrase. The output is not SQL safe. Call $wpdb::prepare()
+     *                or real_escape next.
+     */
+    public function esc_like( $text ) {
         return addcslashes( $text, '_%\\' );
     }