Twenty Seventeen: Various docblock fixes.

audrasjb · audrasjb · commit c734f91a69ae · 2023-07-01T17:02:18.000Z
Props sabernhardt, audrasjb. Fixes #58695. See #57840. git-svn-id: https://develop.svn.wordpress.org/trunk@56121 602fd350-edb4-49c9-b593-d223f7449a82
diff --git a/src/wp-content/themes/twentyseventeen/inc/template-functions.php b/src/wp-content/themes/twentyseventeen/inc/template-functions.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Additional features to allow styling of the templates
+ * Additional features to allow styling of the templates.
  *
  * @package WordPress
  * @subpackage Twenty_Seventeen
@@ -67,9 +67,11 @@ function twentyseventeen_body_classes( $classes ) {
 add_filter( 'body_class', 'twentyseventeen_body_classes' );
 
 /**
- * Count our number of active panels.
+ * Counts the number of our active panels.
  *
- * Primarily used to see if we have any panels active, duh.
+ * Primarily used to see if we have any panels active.
+ *
+ * @return int The number of active panels.
  */
 function twentyseventeen_panel_count() {
 
@@ -95,7 +97,9 @@ function twentyseventeen_panel_count() {
 }
 
 /**
- * Checks to see if we're on the front page or not.
+ * Checks to see if we are on the front page or not.
+ *
+ * @return bool Whether we are on the front page or not.
  */
 function twentyseventeen_is_frontpage() {
 	return ( is_front_page() && ! is_home() );
diff --git a/src/wp-content/themes/twentyseventeen/inc/template-tags.php b/src/wp-content/themes/twentyseventeen/inc/template-tags.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * Custom template tags for this theme
+ * Custom template tags for this theme.
  *
  * Eventually, some of the functionality here could be replaced by core features.
  *
@@ -70,7 +70,7 @@ function twentyseventeen_entry_footer() {
 		// Get Tags for posts.
 		$tags_list = get_the_tag_list( '', $separate_meta );
 
-		// We don't want to output .entry-footer if it will be empty, so make sure its not.
+		// We don't want to output .entry-footer if it will be empty, so make sure it is not.
 		if ( ( ( twentyseventeen_categorized_blog() && $categories_list ) || $tags_list ) || get_edit_post_link() ) {
 
 			echo '<footer class="entry-footer">';
@@ -112,7 +112,7 @@ function twentyseventeen_entry_footer() {
 	/**
 	 * Returns an accessibility-friendly link to edit a post or page.
 	 *
-	 * This also gives us a little context about what exactly we're editing
+	 * This also gives a little context about what exactly we're editing
 	 * (post or page?) so that users understand a bit more where they are in terms
 	 * of the template hierarchy and their content. Helpful when/if the single-page
 	 * layout with multiple posts/pages shown gets confusing.
@@ -131,13 +131,13 @@ function twentyseventeen_edit_link() {
 endif;
 
 /**
- * Display a front page section.
+ * Displays a front page section.
  *
  * @global int|string $twentyseventeencounter Front page section counter.
  * @global WP_Post    $post                   Global post object.
  *
  * @param WP_Customize_Partial $partial Partial associated with a selective refresh request.
- * @param int                  $id Front page section to display.
+ * @param int                  $id      Front page section to display.
  */
 function twentyseventeen_front_page_section( $partial = null, $id = 0 ) {
 	if ( is_a( $partial, 'WP_Customize_Partial' ) ) {
@@ -205,7 +205,7 @@ function twentyseventeen_categorized_blog() {
 
 
 /**
- * Flush out the transients used in twentyseventeen_categorized_blog.
+ * Flushes out the transients used in twentyseventeen_categorized_blog.
  */
 function twentyseventeen_category_transient_flusher() {
 	if ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) {
@@ -219,15 +219,15 @@ function twentyseventeen_category_transient_flusher() {
 
 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.
 	 *
 	 * @since Twenty Seventeen 2.2
 	 */
 	function wp_body_open() {
 		/**
-		 * Triggered after the opening <body> tag.
+		 * Fires after the opening <body> tag.
 		 *
 		 * @since Twenty Seventeen 2.2
 		 */
