Ticket #24413: 24413.patch

wp-content/themes/twentythirteen/functions.php

@@ -179 +179 @@
  * @since Twenty Thirteen 1.0
  *
  * @param string $mce_css CSS path to load in TinyMCE.
- * @return string
+ * @return string The filtered CSS paths list.
  */
 function twentythirteen_mce_css( $mce_css ) {
         $fonts_url = twentythirteen_fonts_url();
@@ -237 +237 @@
  *
  * @param string $title Default title text for current view.
  * @param string $sep Optional separator.
- * @return string Filtered title.
+ * @return string The filtered title.
  */
 function twentythirteen_wp_title( $title, $sep ) {
         global $paged, $page;
@@ -357 +357 @@
 
 if ( ! function_exists( 'twentythirteen_entry_meta' ) ) :
 /**
- * Prints HTML with meta information for current post: categories, tags, permalink, author, and date.
+ * Prints HTML with meta information for current post.
  *
+ * Printed meta includes:
+ * 1. categories
+ * 2. tags
+ * 3. permalink
+ * 4. author
+ * 5. date
+ *
  * Create your own twentythirteen_entry_meta() to override in a child theme.
  *
  * @since Twenty Thirteen 1.0
@@ -404 +411 @@
  * @since Twenty Thirteen 1.0
  *
  * @param boolean $echo Whether to echo the date. Default true.
- * @return string
+ * @return string The HTML-formatted post date.
  */
 function twentythirteen_entry_date( $echo = true ) {
         $format_prefix = ( has_post_format( 'chat' ) || has_post_format( 'status' ) ) ? _x( '%1$s on %2$s', '1: post format name. 2: date', 'twentythirteen' ): '%2$s';
@@ -426 +433 @@
 /**
  * Returns the URL from the post.
  *
- * @uses get_the_link() to get the URL in the post meta (if it exists) or
+ * @uses get_the_post_format_url() to get the URL in the post meta (if it exists) or
  * the first link found in the post content.
  *
  * Falls back to the post permalink if no URL is found in the post.
  *
  * @since Twenty Thirteen 1.0
- * @return string URL
+ *
+ * @return string The Link format URL.
  */
 function twentythirteen_get_link_url() {
         $has_url = get_the_post_format_url();
@@ -446 +454 @@
  * @since Twenty Thirteen 1.0
  *
  * @param array $atts Combined and filtered attribute list.
- * @return array
+ * @return array The filtered attribute list.
  */
 function twentythirteen_gallery_atts( $atts ) {
         if ( has_post_format( 'gallery' ) && ! is_single() )
@@ -457 +465 @@
 add_filter( 'shortcode_atts_gallery', 'twentythirteen_gallery_atts' );
 
 /**
+ * Sets up special body classes.
+ *
  * Extends the default WordPress body class to denote:
  * 1. Custom fonts enabled.
  * 2. Single or multiple authors.
@@ -465 +475 @@
  *
  * @since Twenty Thirteen 1.0
  *
- * @param array $classes Existing class values.
- * @return array Filtered class values.
+ * @param array $classes A list of existing body class values.
+ * @return array The filtered body class list.
  */
 function twentythirteen_body_class( $classes ) {
 
@@ -507 +517 @@
  *
  * @since Twenty Thirteen 1.0
  *
- * @param array $atts Attribute list.
- * @return array Filtered attribute list.
+ * @param array $atts The attribute list.
+ * @return array The filtered attribute list.
  */
 function twentythirteen_video_width( $atts ) {
         if ( ! is_admin() && has_post_format( 'video' ) ) {