Changeset 30541 for trunk/src/wp-includes/functions.wp-scripts.php

Timestamp:

11/24/2014 05:38:44 AM (10 years ago)

Author:

DrewAPicture

Message:

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.

File:

• trunk/src/wp-includes/functions.wp-scripts.php (modified) (2 diffs)

trunk/src/wp-includes/functions.wp-scripts.php

@@ -91 +91 @@
  *
  * 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()
@@ -104 +104 @@
  *
  * @since 2.6.0
+ *
+ * @todo Documentation cleanup
  *
  * @param string $handle      Script handle the data will be attached to.