Changeset 30536

Timestamp:

11/24/2014 04:41:15 AM (10 years ago)

Author:

DrewAPicture

Message:

Ensure inline code is markdown-escaped as such, and that code snippets in descriptions are properly indented.

Affects DocBlocks for the following core elements:

• Two arguments in _walk_bookmarks()
• A code snippet in the class header for WP_Roles
• A code snippet in the class header for WP_HTTP_Proxy
• Inline code fixes in the summary and a parameter description for WP_oEmbed::discover()
• An argument description in _WP_Editors::parse_settings()
• Inline code fixes in the summary and a parameter description the embed_oembed_discover hook.

Props rarst.
See #30473.

Location:

trunk/src/wp-includes

Files:

• bookmark-template.php (modified) (1 diff)
• capabilities.php (modified) (1 diff)
• class-http.php (modified) (1 diff)
• class-oembed.php (modified) (1 diff)
• class-wp-editor.php (modified) (1 diff)
• class-wp-embed.php (modified) (2 diffs)

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

@@ -35 +35 @@
  *     @type int|bool $show_name        Whether to show link name if available. Accepts 1|true or
  *                                      0|false. Default 0|false.
- *     @type string   $before           The HTML or text to prepend to each bookmark. Default '<li>'.
- *     @type string   $after            The HTML or text to append to each bookmark. Default '</li>'.
+ *     @type string   $before           The HTML or text to prepend to each bookmark. Default `<li>`.
+ *     @type string   $after            The HTML or text to append to each bookmark. Default `</li>`.
  *     @type string   $link_before      The HTML or text to prepend to each bookmark inside the anchor
  *                                      tags. Default empty.

trunk/src/wp-includes/capabilities.php

@@ -14 +14 @@
  * in the value of the 'capability' key.
  *
- * <code>
- * array (
- *      'rolename' => array (
- *          'name' => 'rolename',
- *          'capabilities' => array()
- *      )
- * )
- * </code>
+ *     array (
+ *          'rolename' => array (
+ *              'name' => 'rolename',
+ *              'capabilities' => array()
+ *          )
+ *     )
  *
  * @since 2.0.0

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

@@ -1661 +1661 @@
  *
  * An example can be as seen below.
- * <code>
- * define('WP_PROXY_HOST', '192.168.84.101');
- * define('WP_PROXY_PORT', '8080');
- * define('WP_PROXY_BYPASS_HOSTS', 'localhost, www.example.com, *.wordpress.org');
- * </code>
+ *
+ *     define('WP_PROXY_HOST', '192.168.84.101');
+ *     define('WP_PROXY_PORT', '8080');
+ *     define('WP_PROXY_BYPASS_HOSTS', 'localhost, www.example.com, *.wordpress.org');
  *
  * @link https://core.trac.wordpress.org/ticket/4011 Proxy support ticket in WordPress.

trunk/src/wp-includes/class-oembed.php

@@ -292 +292 @@
 
     /**
-     * Attempts to find oEmbed provider discovery <link> tags at the given URL.
-     *
-     * @param string $url The URL that should be inspected for discovery <link> tags.
+     * Attempts to discover link tags at the given URL for an oEmbed provider.
+     *
+     * @param string $url The URL that should be inspected for discovery `<link>` tags.
      * @return bool|string False on failure, otherwise the oEmbed provider URL.
      */

trunk/src/wp-includes/class-wp-editor.php

@@ -49 +49 @@
      *                                         when pressing the Tab key in TinyMCE. Defualt ':prev,:next'.
      *     @type string     $editor_css        Intended for extra styles for both Visual and Text editors.
-     *                                         Should include <style> tags, and can use "scoped". Default empty.
+     *                                         Should include `<style>` tags, and can use "scoped". Default empty.
      *     @type string     $editor_class      Extra classes to add to the editor textarea elemen. Default empty.
      *     @type bool       $teeny             Whether to output the minimal editor config. Examples include

trunk/src/wp-includes/class-wp-embed.php

@@ -224 +224 @@
 
             /**
-             * Filter whether to inspect the given URL for discoverable <link> tags.
+             * Filter whether to inspect the given URL for discoverable link tags.
              *
              * @since 2.9.0
@@ -230 +230 @@
              * @see WP_oEmbed::discover()
              *
-             * @param bool $enable Whether to enable <link> tag discovery. Default false.
+             * @param bool $enable Whether to enable link tag discovery. Default false.
              */
             $attr['discover'] = ( apply_filters( 'embed_oembed_discover', false ) && author_can( $post_ID, 'unfiltered_html' ) );