Changeset 29163 for trunk/src/wp-includes/formatting.php

Timestamp:

07/14/2014 01:01:22 AM (12 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.

File:

• trunk/src/wp-includes/formatting.php (modified) (1 diff)

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 );