Twenty Eleven: Use third-person singular verbs for some more function descriptions.

Reference: [https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#documenting-tips PHP Documentation Standards: Documenting Tips].

Follow-up to [60506], [60507].

See #63692.

git-svn-id: https://develop.svn.wordpress.org/trunk@60513 602fd350-edb4-49c9-b593-d223f7449a82

Author: SergeyBiryukov

src/wp-content/themes/twentyeleven/functions.php

@@ -52,7 +52,7 @@
 
 if ( ! function_exists( 'twentyeleven_setup' ) ) :
 	/**
-	 * Set up theme defaults and registers support for various WordPress features.
+	 * Sets up theme defaults and registers support for various WordPress features.
 	 *
 	 * Note that this function is hooked into the after_setup_theme hook, which runs
 	 * before the init hook. The init hook is too late for some features, such as indicating
@@ -411,7 +411,7 @@ function twentyeleven_admin_header_style() {
 
 if ( ! function_exists( 'twentyeleven_admin_header_image' ) ) :
 	/**
-	 * Custom header image markup displayed on the Appearance > Header admin panel.
+	 * Displays custom header image markup on the Appearance > Header admin panel.
 	 *
 	 * Referenced via add_theme_support('custom-header') in twentyeleven_setup().
 	 *
@@ -442,7 +442,7 @@ function twentyeleven_admin_header_image() {
 
 if ( ! function_exists( 'twentyeleven_header_image' ) ) :
 	/**
-	 * Custom header image markup displayed.
+	 * Displays custom header image markup.
 	 *
 	 * @since Twenty Eleven 4.5
 	 */
@@ -491,7 +491,7 @@ function twentyeleven_excerpt_length( $length ) {
 
 if ( ! function_exists( 'twentyeleven_continue_reading_link' ) ) :
 	/**
-	 * Return a "Continue Reading" link for excerpts
+	 * Returns a "Continue Reading" link for excerpts.
 	 *
 	 * @since Twenty Eleven 1.0
 	 *
@@ -503,7 +503,7 @@ function twentyeleven_continue_reading_link() {
 endif; // twentyeleven_continue_reading_link()
 
 /**
- * Replace "[...]" in the Read More link with an ellipsis.
+ * Replaces "[...]" in the Read More link with an ellipsis.
  *
  * The "[...]" is appended to automatically generated excerpts.
  *
@@ -654,7 +654,7 @@ function twentyeleven_content_nav( $html_id ) {
 endif; // twentyeleven_content_nav()
 
 /**
- * Return the first link from the post content. If none found, the
+ * Returns the first link from the post content. If none found, the
  * post permalink is used as a fallback.
  *
  * @since Twenty Eleven 1.0
@@ -676,7 +676,7 @@ function twentyeleven_get_first_url() {
 }
 
 /**
- * Return the URL for the first link found in the post content.
+ * Returns the URL for the first link found in the post content.
  *
  * @since Twenty Eleven 1.0
  *
@@ -691,7 +691,7 @@ function twentyeleven_url_grabber() {
 }
 
 /**
- * Count the number of footer sidebars to enable dynamic classes for the footer.
+ * Counts the number of footer sidebars to enable dynamic classes for the footer.
  *
  * @since Twenty Eleven 1.0
  */
@@ -828,7 +828,7 @@ function twentyeleven_comment( $comment, $args, $depth ) {
 
 if ( ! function_exists( 'twentyeleven_posted_on' ) ) :
 	/**
-	 * Print HTML with meta information for the current post-date/time and author.
+	 * Prints HTML with meta information for the current post-date/time and author.
 	 *
 	 * Create your own twentyeleven_posted_on to override in a child theme
 	 *
@@ -940,7 +940,7 @@ function twentyeleven_widget_tag_cloud_args( $args ) {
 
 if ( ! function_exists( 'wp_body_open' ) ) :
 	/**
-	 * Fire the wp_body_open action.
+	 * Fires the wp_body_open action.
 	 *
 	 * Added for backward compatibility to support pre-5.2.0 WordPress versions.
 	 *
@@ -957,7 +957,7 @@ function wp_body_open() {
 endif;
 
 /**
- * Include a skip to content link at the top of the page so that users can bypass the menu.
+ * Includes a skip to content link at the top of the page so that users can bypass the menu.
  *
  * @since Twenty Eleven 3.4
  */

src/wp-content/themes/twentyeleven/inc/theme-options.php

@@ -8,7 +8,7 @@
  */
 
 /**
- * Properly enqueue styles and scripts for our theme options page.
+ * Properly enqueues styles and scripts for our theme options page.
  *
  * This function is attached to the admin_enqueue_scripts action hook.
  *
@@ -65,7 +65,7 @@ function twentyeleven_theme_options_init() {
 add_action( 'admin_init', 'twentyeleven_theme_options_init' );
 
 /**
- * Change the capability required to save the 'twentyeleven_options' options group.
+ * Changes the capability required to save the 'twentyeleven_options' options group.
  *
  * @see twentyeleven_theme_options_init()     First parameter to register_setting() is the name of the options group.
  * @see twentyeleven_theme_options_add_page() The edit_theme_options capability is used for viewing the page.
@@ -141,7 +141,7 @@ function twentyeleven_theme_options_help() {
 }
 
 /**
- * Return an array of color schemes registered for Twenty Eleven.
+ * Returns an array of color schemes registered for Twenty Eleven.
  *
  * @since Twenty Eleven 1.0
  */
@@ -172,7 +172,7 @@ function twentyeleven_color_schemes() {
 }
 
 /**
- * Return an array of layout options registered for Twenty Eleven.
+ * Returns an array of layout options registered for Twenty Eleven.
  *
  * @since Twenty Eleven 1.0
  */
@@ -206,7 +206,7 @@ function twentyeleven_layouts() {
 }
 
 /**
- * Return the default options for Twenty Eleven.
+ * Returns the default options for Twenty Eleven.
  *
  * @since Twenty Eleven 1.0
  *
@@ -234,7 +234,7 @@ function twentyeleven_get_default_theme_options() {
 }
 
 /**
- * Return the default link color for Twenty Eleven, based on color scheme.
+ * Returns the default link color for Twenty Eleven, based on color scheme.
  *
  * @since Twenty Eleven 1.0
  *
@@ -257,7 +257,7 @@ function twentyeleven_get_default_link_color( $color_scheme = null ) {
 }
 
 /**
- * Return the options array for Twenty Eleven.
+ * Returns the options array for Twenty Eleven.
  *
  * @since Twenty Eleven 1.0
  */
@@ -266,7 +266,7 @@ function twentyeleven_get_theme_options() {
 }
 
 /**
- * Render the Color Scheme setting field.
+ * Renders the Color Scheme setting field.
  *
  * @since Twenty Eleven 1.3
  */
@@ -290,7 +290,7 @@ function twentyeleven_settings_field_color_scheme() {
 }
 
 /**
- * Render the Link Color setting field.
+ * Renders the Link Color setting field.
  *
  * @since Twenty Eleven 1.3
  */
@@ -312,7 +312,7 @@ function twentyeleven_settings_field_link_color() {
 }
 
 /**
- * Render the Layout setting field.
+ * Renders the Layout setting field.
  *
  * @since Twenty Eleven 1.3
  */
@@ -334,7 +334,7 @@ function twentyeleven_settings_field_layout() {
 }
 
 /**
- * Render the theme options page for Twenty Eleven.
+ * Renders the theme options page for Twenty Eleven.
  *
  * @since Twenty Eleven 1.2
  */
@@ -362,7 +362,7 @@ function twentyeleven_theme_options_render_page() {
 }
 
 /**
- * Sanitize and validate form input.
+ * Sanitizes and validates form input.
  *
  * Accepts an array, return a sanitized array.
  *
@@ -640,7 +640,7 @@ function twentyeleven_customize_register( $wp_customize ) {
 add_action( 'customize_register', 'twentyeleven_customize_register' );
 
 /**
- * Render the site title for the selective refresh partial.
+ * Renders the site title for the selective refresh partial.
  *
  * @since Twenty Eleven 2.4
  *
@@ -653,7 +653,7 @@ function twentyeleven_customize_partial_blogname() {
 }
 
 /**
- * Render the site tagline for the selective refresh partial.
+ * Renders the site tagline for the selective refresh partial.
  *
  * @since Twenty Eleven 2.4
  *
@@ -666,7 +666,7 @@ function twentyeleven_customize_partial_blogdescription() {
 }
 
 /**
- * Bind JS handlers to make Customizer preview reload changes asynchronously.
+ * Binds JS handlers to make Customizer preview reload changes asynchronously.
  *
  * Used with blogname and blogdescription.
  *

src/wp-content/themes/twentyeleven/inc/widgets.php

@@ -150,7 +150,7 @@ public function widget( $args, $instance ) {
 	}
 
 	/**
-	 * Update widget settings.
+	 * Updates widget settings.
 	 *
 	 * Deals with the settings when they are saved by the admin. Here is
 	 * where any validation should be dealt with.
@@ -172,7 +172,7 @@ public function update( $new_instance, $old_instance ) {
 	}
 
 	/**
-	 * Flush widget cache.
+	 * Flushes widget cache.
 	 *
 	 * @since Twenty Eleven 1.0
 	 */