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

Affects DocBlocks for the following core elements:
* Backtick-escapes a `<link>` tag in a parameter description for the `embed_oembed_discover` hook
* Inline code fixes in the summary and return description for `WP_List_Table::get_table_classes()`
* Removes HTML markup from the summary for `WP_List_Table::display_rows_or_placeholder()`
* Backtick-escapes a `<tr>` tag in a parameter description for `WP_Users_List_Table::single_row()`
* Converts non-DocBlocks into multi-line comments in `WP_Dependencies::do_items()`
* Removes HTML markup from the summary for the `comment_form_top` hook.
* Inline code and snippet fixes in the description for `wp_get_schedules()`

Props rarst for the initial patch.
See #30473.

Built from https://develop.svn.wordpress.org/trunk@30537


git-svn-id: http://core.svn.wordpress.org/trunk@30526 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2014-11-24 04:58:22 +00:00
parent 8f6188ae53
commit 273396fe1e
6 changed files with 18 additions and 18 deletions

View File

@ -913,12 +913,12 @@ class WP_List_Table {
} }
/** /**
* Get a list of CSS classes for the <table> tag * Get a list of CSS classes for the list table table tag.
* *
* @since 3.1.0 * @since 3.1.0
* @access protected * @access protected
* *
* @return array * @return array List of CSS classes for the table tag.
*/ */
protected function get_table_classes() { protected function get_table_classes() {
return array( 'widefat', 'fixed', $this->_args['plural'] ); return array( 'widefat', 'fixed', $this->_args['plural'] );
@ -958,7 +958,7 @@ class WP_List_Table {
protected function extra_tablenav( $which ) {} protected function extra_tablenav( $which ) {}
/** /**
* Generate the <tbody> part of the table * Generate the tbody element for the list table.
* *
* @since 3.1.0 * @since 3.1.0
* @access public * @access public

View File

@ -331,7 +331,7 @@ class WP_Users_List_Table extends WP_List_Table {
* @access public * @access public
* *
* @param object $user_object The current user object. * @param object $user_object The current user object.
* @param string $style Optional. Style attributes added to the <tr> element. * @param string $style Optional. Style attributes added to the `<tr>` element.
* Must be sanitized. Default empty. * Must be sanitized. Default empty.
* @param string $role Optional. Key for the $wp_roles array. Default empty. * @param string $role Optional. Key for the $wp_roles array. Default empty.
* @param int $numposts Optional. Post count to display for this user. Defaults * @param int $numposts Optional. Post count to display for this user. Defaults

View File

@ -229,7 +229,7 @@ class WP_Embed {
* *
* @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' ) );

View File

@ -89,7 +89,7 @@ class WP_Dependencies {
* @return array Handles of items that have been processed. * @return array Handles of items that have been processed.
*/ */
public function do_items( $handles = false, $group = false ) { public function do_items( $handles = false, $group = false ) {
/** /*
* If nothing is passed, print the queue. If a string is passed, * If nothing is passed, print the queue. If a string is passed,
* print that item. If an array is passed, print those items. * print that item. If an array is passed, print those items.
*/ */
@ -99,7 +99,7 @@ class WP_Dependencies {
foreach( $this->to_do as $key => $handle ) { foreach( $this->to_do as $key => $handle ) {
if ( !in_array($handle, $this->done, true) && isset($this->registered[$handle]) ) { if ( !in_array($handle, $this->done, true) && isset($this->registered[$handle]) ) {
/** /*
* A single item may alias a set of items, by having dependencies, * A single item may alias a set of items, by having dependencies,
* but no source. Queuing the item queues the dependencies. * but no source. Queuing the item queues the dependencies.
* *
@ -107,13 +107,13 @@ class WP_Dependencies {
* <code>add( 'scriptaculous', false, array( 'scriptaculous-dragdrop', 'scriptaculous-slider', 'scriptaculous-controls' ) );</code> * <code>add( 'scriptaculous', false, array( 'scriptaculous-dragdrop', 'scriptaculous-slider', 'scriptaculous-controls' ) );</code>
* *
* The src property is false. * The src property is false.
**/ */
if ( ! $this->registered[$handle]->src ) { if ( ! $this->registered[$handle]->src ) {
$this->done[] = $handle; $this->done[] = $handle;
continue; continue;
} }
/** /*
* Attempt to process the item. If successful, * Attempt to process the item. If successful,
* add the handle to the done array. * add the handle to the done array.
* *

View File

@ -349,17 +349,17 @@ function wp_cron() {
* 60*60*24*7 or 604800. The value of 'interval' would then be 604800. * 60*60*24*7 or 604800. The value of 'interval' would then be 604800.
* *
* The 'display' is the description. For the 'weekly' key, the 'display' would * The 'display' is the description. For the 'weekly' key, the 'display' would
* be <code>__('Once Weekly')</code>. * be `__( 'Once Weekly' )`.
* *
* For your plugin, you will be passed an array. you can easily add your * For your plugin, you will be passed an array. you can easily add your
* schedule by doing the following. * schedule by doing the following.
* <code> *
* // filter parameter variable name is 'array' * // Filter parameter variable name is 'array'.
* $array['weekly'] = array( * $array['weekly'] = array(
* 'interval' => 604800, * 'interval' => 604800,
* 'display' => __('Once Weekly') * 'display' => __( 'Once Weekly' )
* ); * );
* </code> *
* *
* @since 2.1.0 * @since 2.1.0
* *

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.1-beta2-30536'; $wp_version = '4.1-beta2-30537';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.