PHPCS passing for class-wc-logger-interface.php

includes/interfaces/class-wc-logger-interface.php

@@ -1,6 +1,13 @@
 <?php
+/**
+ * Logger Interface
+ *
+ * @version 3.0.0
+ * @package WooCommerce/Interface
+ */
+
 if ( ! defined( 'ABSPATH' ) ) {
-	exit; // Exit if accessed directly
+	exit; // Exit if accessed directly.
 }
 
 /**
@@ -8,9 +15,7 @@ if ( ! defined( 'ABSPATH' ) ) {
  *
  * Functions that must be defined to correctly fulfill logger API.
  *
- * @version        1.0.0
- * @category       Interface
- * @author         WooThemes
+ * @version 3.0.0
  */
 interface WC_Logger_Interface {
 
@@ -20,9 +25,9 @@ interface WC_Logger_Interface {
 	 * This is not the preferred method for adding log messages. Please use log() or any one of
 	 * the level methods (debug(), info(), etc.). This method may be deprecated in the future.
 	 *
-	 * @param string $handle
-	 * @param string $message
-	 * @param string $level
+	 * @param string $handle File handle.
+	 * @param string $message Log message.
+	 * @param string $level Log level.
 	 *
 	 * @return bool True if log was added, otherwise false.
 	 */
@@ -41,7 +46,7 @@ interface WC_Logger_Interface {
 	 *     'info': Informational messages.
 	 *     'debug': Debug-level messages.
 	 * @param string $message Log message.
-	 * @param array $context Optional. Additional information for log handlers.
+	 * @param array  $context Optional. Additional information for log handlers.
 	 */
 	public function log( $level, $message, $context = array() );
 
@@ -51,7 +56,7 @@ interface WC_Logger_Interface {
 	 * System is unusable.
 	 *
 	 * @param string $message Log message.
-	 * @param array $context Optional. Additional information for log handlers.
+	 * @param array  $context Optional. Additional information for log handlers.
 	 */
 	public function emergency( $message, $context = array() );
 
@@ -62,7 +67,7 @@ interface WC_Logger_Interface {
 	 * Example: Entire website down, database unavailable, etc.
 	 *
 	 * @param string $message Log message.
-	 * @param array $context Optional. Additional information for log handlers.
+	 * @param array  $context Optional. Additional information for log handlers.
 	 */
 	public function alert( $message, $context = array() );
 
@@ -73,7 +78,7 @@ interface WC_Logger_Interface {
 	 * Example: Application component unavailable, unexpected exception.
 	 *
 	 * @param string $message Log message.
-	 * @param array $context Optional. Additional information for log handlers.
+	 * @param array  $context Optional. Additional information for log handlers.
 	 */
 	public function critical( $message, $context = array() );
 
@@ -84,7 +89,7 @@ interface WC_Logger_Interface {
 	 * and monitored.
 	 *
 	 * @param string $message Log message.
-	 * @param array $context Optional. Additional information for log handlers.
+	 * @param array  $context Optional. Additional information for log handlers.
 	 */
 	public function error( $message, $context = array() );
 
@@ -97,7 +102,7 @@ interface WC_Logger_Interface {
 	 * necessarily wrong.
 	 *
 	 * @param string $message Log message.
-	 * @param array $context Optional. Additional information for log handlers.
+	 * @param array  $context Optional. Additional information for log handlers.
 	 */
 	public function warning( $message, $context = array() );
 
@@ -107,7 +112,7 @@ interface WC_Logger_Interface {
 	 * Normal but significant events.
 	 *
 	 * @param string $message Log message.
-	 * @param array $context Optional. Additional information for log handlers.
+	 * @param array  $context Optional. Additional information for log handlers.
 	 */
 	public function notice( $message, $context = array() );
 
@@ -118,7 +123,7 @@ interface WC_Logger_Interface {
 	 * Example: User logs in, SQL logs.
 	 *
 	 * @param string $message Log message.
-	 * @param array $context Optional. Additional information for log handlers.
+	 * @param array  $context Optional. Additional information for log handlers.
 	 */
 	public function info( $message, $context = array() );
 
@@ -128,7 +133,7 @@ interface WC_Logger_Interface {
 	 * Detailed debug information.
 	 *
 	 * @param string $message Log message.
-	 * @param array $context Optional. Additional information for log handlers.
+	 * @param array  $context Optional. Additional information for log handlers.
 	 */
 	public function debug( $message, $context = array() );
 }