Adding missing doc blocks.

Author: colinmurphy

plugins/hwp-previews/src/Hooks/Preview_Hooks.php

@@ -15,6 +15,15 @@
 use WP_Post;
 use WP_REST_Response;
 
+/**
+ * Preview Hooks class
+ *
+ * This is the main class for handling preview-related hooks in the HWP Previews plugin.
+ *
+ * @package HWP\Previews
+ *
+ * @since 0.0.1
+ */
 class Preview_Hooks {
 	/**
 	 * Post-settings service that provides access to post-settings.

plugins/hwp-previews/src/Integration/Faust_Integration.php

@@ -8,6 +8,15 @@
 use HWP\Previews\Preview\Post\Post_Preview_Service;
 use HWP\Previews\Preview\Post\Post_Settings_Service;
 
+/**
+ * Faust Integration class
+ *
+ * This class handles the integration with the Faust plugin for HWP Previews and updates the settings accordingly.
+ *
+ * @package HWP\Previews
+ *
+ * @since 0.0.1
+ */
 class Faust_Integration {
 	/**
 	 * The key for the admin notice.

plugins/hwp-previews/src/Preview/Parameter/Preview_Parameter.php

@@ -7,7 +7,13 @@
 use WP_Post;
 
 /**
- * Class Callable_Preview_Parameter.
+ * Preview Parameter class
+ *
+ * This class represents a parameter for the preview URL.
+ *
+ * @package HWP\Previews
+ *
+ * @since 0.0.1
  */
 class Preview_Parameter {
 	/**

plugins/hwp-previews/src/Preview/Parameter/Preview_Parameter_Registry.php

@@ -11,6 +11,10 @@
  * Class Preview_Parameter_Registry.
  *
  * This class is responsible for registering and managing preview parameters.
+ *
+ * @package HwP\Previews
+ *
+ * @since 0.0.1
  */
 class Preview_Parameter_Registry {
 	/**

plugins/hwp-previews/src/Preview/Post/Post_Editor_Service.php

@@ -6,11 +6,21 @@
 
 use WP_Post_Type;
 
+
+/**
+ * Post Editor Service class
+ *
+ * This class provides methods to check if the post-type supports Gutenberg editor
+ *
+ * @package HWP\Previews
+ *
+ * @since 0.0.1
+ */
 class Post_Editor_Service {
 	/**
 	 * Check if the post-type supports Gutenberg editor and if the classic editor is not being forced.
 	 *
-	 * @param string $post_type Post Type slug.
+	 * @param string $post_type Post-Type slug.
 	 */
 	public function gutenberg_editor_enabled(string $post_type): bool {
 		$post_type_object = get_post_type_object( $post_type );
@@ -23,7 +33,7 @@ public function gutenberg_editor_enabled(string $post_type): bool {
 	}
 
 	/**
-	 * Checks if the post type supports Gutenberg.
+	 * Checks if the post-type supports Gutenberg.
 	 *
 	 * @param \WP_Post_Type $post_type Post Type object.
 	 */
@@ -41,7 +51,7 @@ public function is_gutenberg_supported( WP_Post_Type $post_type ): bool {
 	}
 
 	/**
-	 * Checks if the post type is supported by Classic Editor.
+	 * Checks if the post-type is supported by Classic Editor.
 	 */
 	public function is_classic_editor_forced(string $post_type): bool {
 		if (

plugins/hwp-previews/src/Preview/Post/Post_Preview_Service.php

@@ -4,6 +4,17 @@
 
 namespace HWP\Previews\Preview\Post;
 
+
+/**
+ * Post Preview Service class
+ *
+ * This class provides methods to get the allowed post-types and statuses for previews.
+ *
+ * @package HWP\Previews
+ *
+ * @since 0.0.1
+ */
+
 class Post_Preview_Service {
 	/**
 	 * The allowed post-types for previews.
@@ -45,7 +56,7 @@ public function get_allowed_post_types(): array {
 	}
 
 	/**
-	 * Get the post statuses.
+	 * Get the post-statuses.
 	 *
 	 * @return array<string>
 	 */
@@ -54,7 +65,7 @@ public function get_post_statuses(): array {
 	}
 
 	/**
-	 * Get the post types.
+	 * Get the post-types.
 	 *
 	 * @return array<string>
 	 */
@@ -63,7 +74,7 @@ public function get_post_types(): array {
 	}
 
 	/**
-	 * Get the parent post statuses
+	 * Get the parent post-statuses
 	 *
 	 * @return array<string>
 	 */
@@ -72,7 +83,7 @@ public function get_parent_post_statuses(): array {
 	}
 
 	/**
-	 * Sets the allowed post types for previews.
+	 * Sets the allowed post-types for previews.
 	 */
 	protected function set_post_types(): void {
 		$post_types = get_post_types( [ 'public' => true ], 'objects' );
@@ -87,7 +98,7 @@ protected function set_post_types(): void {
 	}
 
 	/**
-	 * Sets the allowed post statuses for previews.
+	 * Sets the allowed post-statuses for previews.
 	 */
 	protected function set_post_statuses(): void {
 
@@ -104,7 +115,7 @@ protected function set_post_statuses(): void {
 	}
 
 	/**
-	 * Sets the allowed post statuses for parent post-types (hierarchael).
+	 * Sets the allowed post-statuses for parent post-types (hierarchical).
 	 */
 	protected function set_post_parent_statuses(): void {
 

plugins/hwp-previews/src/Preview/Post/Post_Settings_Service.php

@@ -4,6 +4,16 @@
 
 namespace HWP\Previews\Preview\Post;
 
+
+/**
+ * Post-Settings Service class
+ *
+ * This class provides methods to retrieve and manage post-settings for the HWP Previews plugin.
+ *
+ * @package HWP\Previews
+ *
+ * @since 0.0.1
+ */
 class Post_Settings_Service {
 	/**
 	 * The settings value
@@ -52,7 +62,7 @@ public static function get_settings_group(): string {
 	}
 
 	/**
-	 * Setup the settings values by retrieving them from the database or cache.
+	 * Set up the settings values it by retrieving them from the database or cache.
 	 * This method is called in the constructor to ensure settings are available.
 	 */
 	protected function setup(): void {

plugins/hwp-previews/src/Preview/Post/Post_Type_Service.php

@@ -7,6 +7,15 @@
 use HWP\Previews\Admin\Settings\Fields\Settings_Field_Collection;
 use WP_Post;
 
+/**
+ * Post-Type Service class
+ *
+ * This class provides methods to retrieve and manage post-settings for the HWP Previews plugin.
+ *
+ * @package HWP\Previews
+ *
+ * @since 0.0.1
+ */
 class Post_Type_Service {
 	/**
 	 * The post-object
@@ -16,14 +25,14 @@ class Post_Type_Service {
 	protected WP_Post $post;
 
 	/**
-	 * Post-preview service that provide information about the post type for previews.
+	 * Post-preview service that provide information about the post-type for previews.
 	 *
 	 * @var \HWP\Previews\Preview\Post\Post_Preview_Service
 	 */
 	private Post_Preview_Service $post_preview_service;
 
 	/**
-	 * Settings service to retrieve post type settings.
+	 * Settings service to retrieve post-type settings.
 	 *
 	 * @var \HWP\Previews\Preview\Post\Post_Settings_Service
 	 */
@@ -41,7 +50,7 @@ public function __construct( WP_Post $post, Post_Preview_Service $post_preview_s
 	}
 
 	/**
-	 * Checks if the post type is allowed for previews.
+	 * Checks if the post-type is allowed for previews.
 	 */
 	public function is_allowed_for_previews(): bool {
 		return $this->is_enabled() && $this->is_allowed_post_type() && $this->is_allowed_post_status();

plugins/hwp-previews/src/Templates/admin.php

@@ -1,5 +1,13 @@
 <?php
 
+/**
+ * The admin settings page for the HWP Previews plugin.
+ *
+ * @package HWP\Previews
+ *
+ * @since 0.0.1
+ */
+
 declare(strict_types=1);
 
 use HWP\Previews\Integration\Faust_Integration;

plugins/hwp-previews/src/Templates/iframe.php

@@ -5,6 +5,8 @@
  * This template will be used for all post/page previews
  *
  * @package HWP\Previews
+ *
+ * @since 0.0.1
  */
 
 declare(strict_types=1);