PHPCS comment fixes for functions.php

Author: NickGreen

themes/osi/functions.php

@@ -14,6 +14,8 @@
 	 * 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 support for post thumbnails.
+	 *
+	 * @return void
 	 */
 	function osi_setup() {
 		/*
@@ -114,6 +116,8 @@ function osi_setup() {
 
 /**
  * Register sidebars and widgets
+ *
+ * @return void
  */
 function osi_widgets_init() {
 	// Sidebars
@@ -168,7 +172,8 @@ function osi_widgets_init() {
  *
  * Priority 0 to make it available to lower priority callbacks.
  *
- * @global int $content_width
+ * @global int $content_width Content width to set.
+ * @return void
  */
 function osi_content_width() {
 	$GLOBALS['content_width'] = apply_filters( 'osi_content_width', 640 );
@@ -177,6 +182,8 @@ function osi_content_width() {
 
 /**
  * Add a reusable block admin menu link for easy administration.
+ *
+ * @return void
  */
 function osi_reusable_blocks_admin_menu(): void {
 	add_theme_page(
@@ -192,6 +199,8 @@ function osi_reusable_blocks_admin_menu(): void {
 
 /**
  * Enqueue scripts and styles.
+ *
+ * @return void
  */
 function osi_scripts() {
 	wp_enqueue_style(
@@ -226,7 +235,11 @@ function osi_scripts() {
 }
 add_action( 'wp_enqueue_scripts', 'osi_scripts' );
 
-/** Frontend Inline Styles **/
+/**
+ * Add inline styles to the frontend.
+ *
+ * @return void
+ */
 function osi_inline_styles() {
 	wp_add_inline_style( 'osi-style', osi_palette_css() );
 	wp_add_inline_style( 'osi-style', osi_gradient_css() );
@@ -235,7 +248,11 @@ function osi_inline_styles() {
 }
 add_action( 'wp_enqueue_scripts', 'osi_inline_styles', 100 ); // prioritize as last
 
-/** Block Editor Styles **/
+/**
+ * Add block editor assets.
+ *
+ * @return void
+ */
 function osi_add_block_editor_assets() {
 	wp_enqueue_style( 'editor-styles', get_template_directory_uri() . '/assets/css/editor-style.css', '', 1 );
 	wp_add_inline_style( 'editor-styles', osi_palette_css() );
@@ -316,6 +333,8 @@ function osi_add_block_editor_assets() {
 
 /**
  * Register the "Footer - Above credits" sidebar.
+ *
+ * @return void
  */
 function register_footer_above_sidebar() {
 	register_sidebar(
@@ -333,9 +352,11 @@ function register_footer_above_sidebar() {
 add_action( 'widgets_init', 'register_footer_above_sidebar' );
 
 /**
- * Adjust the 'news' (post archive) to show 1 fewer posts on the first page, for symmetry
+ * Adjust the 'blog' (post archive) to show a different number of posts on the first page.
+ *
+ * @param WP_Query $query WordPress Query object.
+ * @return void
  */
-
 add_action( 'pre_get_posts', 'osi_query_offset', 1 );
 function osi_query_offset( &$query ) {
 	if ( ! ( $query->is_blog() || is_main_query() ) || is_admin() || is_front_page() || is_archive() || is_404() ) {
@@ -356,6 +377,13 @@ function osi_query_offset( &$query ) {
 	}
 }
 
+/**
+ * Adjust the pagination offset.
+ *
+ * @param int      $found_posts The number of found posts.
+ * @param WP_Query $query       WordPress Query object.
+ * @return int Adjusted number of found posts.
+ */
 add_filter( 'found_posts', 'osi_adjust_offset_pagination', 1, 2 );
 function osi_adjust_offset_pagination( $found_posts, $query ) {
 	$offset = -1;