Changeset 30542

Timestamp:

11/24/2014 05:46:04 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 file header for wp-admin/install-helper.php
• Add markdown formatting and two inline @see tags to the description for translate()
• Markdown-indent a code snippet in the description for _n_noop()
• Remove HTML tags from the summary for get_media_embedded_in_content()
• Remove an HTML tag from the summary for wpview_media_sandbox_styles()

Props rarst.
See #30473.

Location:

trunk/src

Files:

• wp-admin/install-helper.php (modified) (1 diff)
• wp-includes/l10n.php (modified) (3 diffs)
• wp-includes/media.php (modified) (2 diffs)

trunk/src/wp-admin/install-helper.php

@@ -11 +11 @@
  * do, then it is advised to just write the SQL code yourself.
  *
- * <code>
- * check_column('wp_links', 'link_description', 'mediumtext');
- * if (check_column($wpdb->comments, 'comment_author', 'tinytext'))
- *     echo "ok\n";
+ *     check_column( 'wp_links', 'link_description', 'mediumtext' );
+ *     if ( check_column( $wpdb->comments, 'comment_author', 'tinytext' ) ) {
+ *         echo "ok\n";
+ *     }
  *
- * $error_count = 0;
- * $tablename = $wpdb->links;
- * // check the column
- * if (!check_column($wpdb->links, 'link_description', 'varchar(255)')) {
- *     $ddl = "ALTER TABLE $wpdb->links MODIFY COLUMN link_description varchar(255) NOT NULL DEFAULT '' ";
- *     $q = $wpdb->query($ddl);
- * }
+ *     $error_count = 0;
+ *     $tablename = $wpdb->links;
+ *     // Check the column.
+ *     if ( ! check_column($wpdb->links, 'link_description', 'varchar( 255 )' ) ) {
+ *         $ddl = "ALTER TABLE $wpdb->links MODIFY COLUMN link_description varchar(255) NOT NULL DEFAULT '' ";
+ *         $q = $wpdb->query( $ddl );
+ *     }
  *
- * if (check_column($wpdb->links, 'link_description', 'varchar(255)')) {
- *     $res .= $tablename . ' - ok <br />';
- * } else {
- *     $res .= 'There was a problem with ' . $tablename . '<br />';
- *     ++$error_count;
- * }
- * </code>
+ *     if ( check_column( $wpdb->links, 'link_description', 'varchar( 255 )' ) ) {
+ *         $res .= $tablename . ' - ok <br />';
+ *     } else {
+ *         $res .= 'There was a problem with ' . $tablename . '<br />';
+ *         ++$error_count;
+ *     }
  *
  * @package WordPress

trunk/src/wp-includes/l10n.php

@@ -77 +77 @@
  * If there is no translation, or the text domain isn't loaded, the original text is returned.
  *
- * <strong>Note:</strong> Don't use translate() directly, use __() or related functions.
+ * *Note:* Don't use {@see translate()} directly, use `{@see __()} or related functions.
  *
  * @since 2.2.0
@@ -88 +88 @@
     $translations = get_translations_for_domain( $domain );
     $translations = $translations->translate( $text );
+
     /**
      * Filter text with its translation.
@@ -365 +366 @@
  *
  * Example:
- * <code>
- * $messages = array(
- *      'post' => _n_noop('%s post', '%s posts'),
- *      'page' => _n_noop('%s pages', '%s pages')
- * );
- * ...
- * $message = $messages[$type];
- * $usable_text = sprintf( translate_nooped_plural( $message, $count ), $count );
- * </code>
+ *
+ *     $messages = array(
+ *          'post' => _n_noop( '%s post', '%s posts' ),
+ *          'page' => _n_noop( '%s pages', '%s pages' ),
+ *     );
+ *     ...
+ *     $message = $messages[ $type ];
+ *     $usable_text = sprintf( translate_nooped_plural( $message, $count ), $count );
  *
  * @since 2.5.0

trunk/src/wp-includes/media.php

@@ -3101 +3101 @@
 
 /**
- * Check the content blob for an <audio>, <video> <object>, <embed>, or <iframe>
+ * Check the content blob for an audio, video, object, embed, or iframe tags.
  *
  * @since 3.6.0
@@ -3287 +3287 @@
 
 /**
- * Return the URls for CSS files used in an <iframe>-sandbox'd TinyMCE media view
+ * Return the URLs for CSS files used in an iframe-sandbox'd TinyMCE media view.
  *
  * @since 4.0.0