Ensure inline code is markdown-escaped as such, HTML tags are removed from summaries, and that code snippets in descriptions are properly indented.

Affects DocBlocks for the following core elements:
* Backtick-escape HTML tags in several argument descriptions for `wp_link_pages()`
* Remove an HTML tag from the summary for `prepend_attachment()`
* Backtick-escape inline code in the description for `get_extended()`
* Backtick-escape inline code in the description for `get_post_type_labels()`
* Various markdown formatting in the description for `add_rewrite_endpoint()`
* Markdown-indent a code snippet in the file header for wp-includes/shortcodes.php
* Markdown-indent code snippets in the description for `add_shortcode()

Props rarst.
See #30473.


git-svn-id: https://develop.svn.wordpress.org/trunk@30545 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes (DrewAPicture)
2014-11-24 06:14:03 +00:00
parent 5f574c7ec8
commit 76699122d0
4 changed files with 36 additions and 44 deletions

View File

@@ -372,8 +372,8 @@ function get_children( $args = '', $output = OBJECT ) {
* referenced.
*
* The returned array has 'main', 'extended', and 'more_text' keys. Main has the text before
* the <code><!--more--></code>. The 'extended' key has the content after the
* <code><!--more--></code> comment. The 'more_text' key has the custom "Read More" text.
* the `<!--more-->`. The 'extended' key has the content after the
* `<!--more-->` comment. The 'more_text' key has the custom "Read More" text.
*
* @since 1.0.0
*
@@ -1594,8 +1594,8 @@ function _post_type_meta_capabilities( $capabilities = null ) {
* - singular_name - name for one object of this post type. Default is Post/Page
* - add_new - Default is Add New for both hierarchical and non-hierarchical types.
* When internationalizing this string, please use a gettext context
* {@see http://codex.wordpress.org/I18n_for_WordPress_Developers#Disambiguation_by_context}
* matching your post type. Example: <code>_x('Add New', 'product');</code>.
* {@link http://codex.wordpress.org/I18n_for_WordPress_Developers#Disambiguation_by_context}
* matching your post type. Example: `_x( 'Add New', 'product' );`.
* - add_new_item - Default is Add New Post/Add New Page.
* - edit_item - Default is Edit Post/Edit Page.
* - new_item - Default is New Post/New Page.
@@ -1606,7 +1606,7 @@ function _post_type_meta_capabilities( $capabilities = null ) {
* - parent_item_colon - This string isn't used on non-hierarchical types. In hierarchical
* ones the default is 'Parent Page:'.
* - all_items - String for the submenu. Default is All Posts/All Pages.
* - menu_name - Default is the same as <code>name</code>.
* - menu_name - Default is the same as `name`.
*
* Above, the first default value is for non-hierarchical post types (like posts)
* and the second one is for hierarchical post types (like pages).