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.


git-svn-id: https://develop.svn.wordpress.org/trunk@30536 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes (DrewAPicture) 2014-11-24 04:41:15 +00:00
parent f50cafce29
commit f843741d33
6 changed files with 17 additions and 20 deletions

View File

@ -34,8 +34,8 @@
* or 0|false. Default 1|true. * or 0|false. Default 1|true.
* @type int|bool $show_name Whether to show link name if available. Accepts 1|true or * @type int|bool $show_name Whether to show link name if available. Accepts 1|true or
* 0|false. Default 0|false. * 0|false. Default 0|false.
* @type string $before The HTML or text to prepend 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 $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 * @type string $link_before The HTML or text to prepend to each bookmark inside the anchor
* tags. Default empty. * tags. Default empty.
* @type string $link_after The HTML or text to append to each bookmark inside the anchor * @type string $link_after The HTML or text to append to each bookmark inside the anchor

View File

@ -13,14 +13,12 @@
* the name in value of the 'name' key. The capabilities are stored as an array * the name in value of the 'name' key. The capabilities are stored as an array
* in the value of the 'capability' key. * in the value of the 'capability' key.
* *
* <code>
* array ( * array (
* 'rolename' => array ( * 'rolename' => array (
* 'name' => 'rolename', * 'name' => 'rolename',
* 'capabilities' => array() * 'capabilities' => array()
* ) * )
* ) * )
* </code>
* *
* @since 2.0.0 * @since 2.0.0
* @package WordPress * @package WordPress

View File

@ -1660,11 +1660,10 @@ class WP_Http_Curl {
* </ol> * </ol>
* *
* An example can be as seen below. * An example can be as seen below.
* <code> *
* define('WP_PROXY_HOST', '192.168.84.101'); * define('WP_PROXY_HOST', '192.168.84.101');
* define('WP_PROXY_PORT', '8080'); * define('WP_PROXY_PORT', '8080');
* define('WP_PROXY_BYPASS_HOSTS', 'localhost, www.example.com, *.wordpress.org'); * define('WP_PROXY_BYPASS_HOSTS', 'localhost, www.example.com, *.wordpress.org');
* </code>
* *
* @link https://core.trac.wordpress.org/ticket/4011 Proxy support ticket in WordPress. * @link https://core.trac.wordpress.org/ticket/4011 Proxy support ticket in WordPress.
* @link https://core.trac.wordpress.org/ticket/14636 Allow wildcard domains in WP_PROXY_BYPASS_HOSTS * @link https://core.trac.wordpress.org/ticket/14636 Allow wildcard domains in WP_PROXY_BYPASS_HOSTS

View File

@ -291,9 +291,9 @@ class WP_oEmbed {
} }
/** /**
* Attempts to find oEmbed provider discovery <link> tags at the given URL. * 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. * @param string $url The URL that should be inspected for discovery `<link>` tags.
* @return bool|string False on failure, otherwise the oEmbed provider URL. * @return bool|string False on failure, otherwise the oEmbed provider URL.
*/ */
public function discover( $url ) { public function discover( $url ) {

View File

@ -48,7 +48,7 @@ final class _WP_Editors {
* @type string $tabfocus_elements The previous and next element ID to move the focus to * @type string $tabfocus_elements The previous and next element ID to move the focus to
* when pressing the Tab key in TinyMCE. Defualt ':prev,:next'. * when pressing the Tab key in TinyMCE. Defualt ':prev,:next'.
* @type string $editor_css Intended for extra styles for both Visual and Text editors. * @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 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 * @type bool $teeny Whether to output the minimal editor config. Examples include
* Press This and the Comment editor. Default false. * Press This and the Comment editor. Default false.

View File

@ -223,13 +223,13 @@ class WP_Embed {
} }
/** /**
* 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 * @since 2.9.0
* *
* @see WP_oEmbed::discover() * @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' ) ); $attr['discover'] = ( apply_filters( 'embed_oembed_discover', false ) && author_can( $post_ID, 'unfiltered_html' ) );