Changeset 36820

Timestamp:

03/03/2016 07:03:23 AM (11 years ago)

Author:

DrewAPicture

Message:

Docs: Use third-person singular verbs in DocBlock summaries for the WP_Site_Logo class, introduced in [36698].

Also minorly improves various inline docs.

See #33755. See #35986.

File:

• trunk/src/wp-admin/includes/class-wp-site-logo.php (modified) (7 diffs)

trunk/src/wp-admin/includes/class-wp-site-logo.php

@@ -28 +28 @@
 
         /**
-         * Hide header text on front end if necessary.
+         * Hides header text on the front end if necessary.
          *
          * @since 4.5.0
@@ -39 +39 @@
                 }
 
-                // Is Display Header Text unchecked? If so, we need to hide our header text.
+                // Is Display Header Text unchecked? If so, hide the header text.
                 ?>
                 <!-- Site Logo: hide header text -->
@@ -52 +52 @@
 
         /**
-         * Reset the site logo if the current logo is deleted in the media manager.
+         * Resets the site logo if the current logo is deleted in the media manager.
          *
          * @since 4.5.0
          * @access public
          *
-         * @param int $post_id
+         * @param int $post_id Post ID.
          */
         public function delete_attachment_data( $post_id ) {
@@ -68 +68 @@
 
         /**
-         * Make custom image sizes available to the media manager.
+         * Makes custom image sizes available to the media manager.
          *
          * @since 4.5.0
@@ -81 +81 @@
                 $intermediate = get_intermediate_image_sizes();
 
-                // Have we got anything fun to work with?
+                // Is there anything fun to work with?
                 if ( is_array( $intermediate ) && ! empty( $intermediate ) ) {
                         foreach ( $intermediate as $key => $size ) {
@@ -96 +96 @@
 
         /**
-         * Get header text classes. If not defined in add_theme_support(), defaults from Underscores will be used.
+         * Retrieves the header text classes.
+         *
+         * If not defined in add_theme_support(), defaults from Underscores will be used.
          *
          * @since 4.5.0
          * @access protected
          *
-         * @return string String of classes to hide
+         * @return string String of classes to hide.
          */
         protected function header_text_classes() {
@@ -117 +119 @@
                 }
 
-                // If we've got an array, reduce them to a string for output.
+                // If there's an array of classes, reduce them to a string for output.
                 if ( is_array( $classes ) ) {
                         $classes = array_map( 'sanitize_html_class', $classes );