Merge pull request #369 from Yoast/JRF/docs-various-updates

Docs: various updates

inc/assets.php

@@ -19,6 +19,8 @@ class Yoast_ACF_Analysis_Assets {
 
 	/**
 	 * Initialize.
+	 *
+	 * @return void
 	 */
 	public function init() {
 		$this->plugin_data = get_plugin_data( AC_SEO_ACF_ANALYSIS_PLUGIN_FILE );
@@ -28,6 +30,8 @@ public function init() {
 
 	/**
 	 * Enqueue JavaScript file to feed data to Yoast Content Analyses.
+	 *
+	 * @return void
 	 */
 	public function enqueue_scripts() {
 		/**

inc/configuration/configuration.php

@@ -373,7 +373,7 @@ public function get_field_order() {
 	/**
 	 * Retrieves an array representation of the current object.
 	 *
-	 * @return array
+	 * @return array<string, mixed>
 	 */
 	public function to_array() {
 		return [

inc/dependencies/dependency-acf.php

@@ -31,13 +31,17 @@ public function is_met() {
 
 	/**
 	 * Registers the notification to show when the conditions are not met.
+	 *
+	 * @return void
 	 */
 	public function register_notifications() {
 		add_action( 'admin_notices', [ $this, 'message_plugin_not_activated' ] );
 	}
 
 	/**
 	 * Notify that we need ACF to be installed and active.
+	 *
+	 * @return void
 	 */
 	public function message_plugin_not_activated() {
 		$message = sprintf(

inc/dependencies/dependency-yoast-seo.php

@@ -31,6 +31,8 @@ public function is_met() {
 
 	/**
 	 * Registers the notifications to be shown.
+	 *
+	 * @return void
 	 */
 	public function register_notifications() {
 		if ( ! defined( 'WPSEO_VERSION' ) ) {
@@ -45,6 +47,8 @@ public function register_notifications() {
 
 	/**
 	 * Notify that we need Yoast SEO for WordPress to be installed and active.
+	 *
+	 * @return void
 	 */
 	public function message_plugin_not_activated() {
 		$message = sprintf(
@@ -59,6 +63,8 @@ public function message_plugin_not_activated() {
 
 	/**
 	 * Notify that we need Yoast SEO for WordPress to be installed and active.
+	 *
+	 * @return void
 	 */
 	public function message_minimum_version() {
 		$message = sprintf(

inc/registry.php

@@ -22,6 +22,8 @@ class Yoast_ACF_Analysis_Registry {
 	 *
 	 * @param string|int $id   Registry index.
 	 * @param mixed      $item Item to store in the registry.
+	 *
+	 * @return void
 	 */
 	public function add( $id, $item ) {
 		$this->storage[ $id ] = $item;

inc/requirements.php

@@ -21,6 +21,8 @@ class Yoast_ACF_Analysis_Requirements {
 	 * Adds a dependency.
 	 *
 	 * @param Yoast_ACF_Analysis_Dependency $dependency Dependency to add.
+	 *
+	 * @return void
 	 */
 	public function add_dependency( Yoast_ACF_Analysis_Dependency $dependency ) {
 		$this->dependencies[] = $dependency;

tests/Unit/Requirements_Test.php

@@ -15,6 +15,8 @@ class Requirements_Test extends TestCase {
 
 	/**
 	 * Sets up test fixtures.
+	 *
+	 * @return void
 	 */
 	protected function set_up() {
 		parent::set_up();

tests/js/system/data/test-data-loader-functions.php

@@ -12,6 +12,8 @@
 
 /**
  * Loads ACF test data for the ACF version being tested.
+ *
+ * @return void
  */
 function yoast_acf_analysis_test_data_loader() {
 

yoast-acf-analysis.php

@@ -49,6 +49,8 @@
 
 /**
  * Show admin notice when ACF is missing.
+ *
+ * @return void
  */
 function yoast_acf_report_missing_acf() {
 	echo '<div class="error"><p>';
@@ -67,6 +69,8 @@ function yoast_acf_report_missing_acf() {
  *
  * @deprecated 2.0.1
  * @codeCoverageIgnore
+ *
+ * @return void
  */
 function yoast_acf_analysis_load_textdomain() {
 	// As we require WordPress 4.6 and higher, we don't need to load the translation files manually anymore.