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:
* Markdown-indent a code snippet in the description for `_deprecated_argument()`
* Markdown-indent a code snippet in the description for `wp_localize_script()`
* Backtick-escape HTML tags in two parameter descriptions for `wp_register()`
* Various DocBlock formatting in the description for `get_bloginfo()`
* Remove HTML tag from the summary for `_wp_render_title_tag()`
* Backtick-escape a HTML tag in the description for `get_archives_link()`
* Markdown-indent a code snippet in the description for `wp_admin_css_color()`
* Markdown-indent a code snippet in the description for the `welcome_panel` hook

Props rarst.
See #30473.


git-svn-id: https://develop.svn.wordpress.org/trunk@30541 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes (DrewAPicture)
2014-11-24 05:38:44 +00:00
parent ac07c17400
commit d93bfdce56
4 changed files with 36 additions and 29 deletions

View File

@@ -90,13 +90,13 @@ function wp_register_script( $handle, $src, $deps = array(), $ver = false, $in_f
* Works only if the script has already been added.
*
* Accepts an associative array $l10n and creates a JavaScript object:
* <code>
* "$object_name" = {
* key: value,
* key: value,
* ...
* }
* </code>
*
* "$object_name" = {
* key: value,
* key: value,
* ...
* }
*
*
* @see WP_Dependencies::localize()
* @link https://core.trac.wordpress.org/ticket/11520
@@ -104,6 +104,8 @@ function wp_register_script( $handle, $src, $deps = array(), $ver = false, $in_f
*
* @since 2.6.0
*
* @todo Documentation cleanup
*
* @param string $handle Script handle the data will be attached to.
* @param string $object_name Name for the JavaScript object. Passed directly, so it should be qualified JS variable.
* Example: '/[a-zA-Z0-9_]+/'.