Documentation comment fixes to be inline with wpcs

Author: pressprogrammer

bp-xprofile-custom-field-types.php

@@ -170,7 +170,7 @@ public function __get( $name ) {
 }
 
 /**
- * Return object of class
+ * Returns singleton instance of BP_Xprofile_CFTR
  *
  * @return BP_Xprofile_CFTR
  */

src/admin/class-admin.php

@@ -21,15 +21,15 @@
 class Admin {
 
 	/**
-	 * Setup the bootstrapper.
+	 * Sets up the bootstrapper.
 	 */
 	public static function boot() {
 		$self = new self();
 		$self->setup();
 	}
 
 	/**
-	 * Bind hooks
+	 * Binds hooks
 	 */
 	private function setup() {
 		// called after pp_loaded.
@@ -38,7 +38,7 @@ private function setup() {
 	}
 
 	/**
-	 * Initialize.
+	 * Initializes.
 	 */
 	public function init() {
 
@@ -51,7 +51,7 @@ public function init() {
 	}
 
 	/**
-	 * Show notices.
+	 * Shows notices.
 	 */
 	public function notices() {
 		$notices = get_option( 'bpxcftr_notices' );

src/admin/class-field-settings-helper.php

@@ -26,15 +26,15 @@
 class Field_Settings_Helper {
 
 	/**
-	 * Setup the bootstrapper.
+	 * Sets up the bootstrapper.
 	 */
 	public static function boot() {
 		$self = new self();
 		$self->setup();
 	}
 
 	/**
-	 * Bind hooks
+	 * Binds hooks
 	 */
 	private function setup() {
 		// save meta.
@@ -45,7 +45,7 @@ private function setup() {
 	}
 
 	/**
-	 * Save the text when the field is saved
+	 * Saves the text when the field is saved
 	 *
 	 * @param \BP_XProfile_Field $field field object.
 	 */
@@ -261,5 +261,4 @@ class="screen-reader-text"><?php _e( 'Select2 status for this field', 'buddypres
         </div>
 		<?php
 	}
-
 }

src/bootstrap/class-assets-loader.php

@@ -21,22 +21,22 @@
 class Assets_Loader {
 
 	/**
-	 * Data to be send as localized js.
+	 * Data to be sent as localized js.
 	 *
 	 * @var array
 	 */
 	private $data = array();
 
 	/**
-	 * Boot itself
+	 * Boots itself
 	 */
 	public static function boot() {
 		$self = new self();
 		$self->setup();
 	}
 
 	/**
-	 * Setup
+	 * Sets up
 	 */
 	public function setup() {
 		add_action( 'bp_enqueue_scripts', array( $this, 'register_front_assets' ) );
@@ -48,7 +48,7 @@ public function setup() {
 	}
 
 	/**
-	 * Register front assets.
+	 * Registers front assets.
 	 */
 	public function register_front_assets() {
 
@@ -60,10 +60,10 @@ public function register_front_assets() {
 	}
 
 	/**
-	 * Load plugin assets
+	 * Loads plugin assets
 	 */
 	public function load_assets() {
-		// css should be always loaded.
+		// css should always be loaded.
 		wp_enqueue_style( 'bp-xprofile-custom-field-types' );
 
 		if ( ! $this->should_load_front_assets() ) {
@@ -74,7 +74,7 @@ public function load_assets() {
 	}
 
 	/**
-	 * Register admin assets.
+	 * Registers admin assets.
 	 */
 	public function register_admin_assets() {
 
@@ -86,7 +86,7 @@ public function register_admin_assets() {
 	}
 
 	/**
-	 * Load plugin assets
+	 * Loads plugin assets
 	 */
 	public function load_admin_assets() {
 
@@ -99,7 +99,7 @@ public function load_admin_assets() {
 	}
 
 	/**
-	 * Load plugin assets
+	 * Loads plugin assets
 	 */
 	public function load_user_admin_assets() {
 
@@ -115,7 +115,7 @@ public function load_user_admin_assets() {
 	}
 
 	/**
-	 * Register assets.
+	 * Registers assets.
 	 */
 	private function register() {
 		$this->register_vendors();
@@ -124,7 +124,7 @@ private function register() {
 	}
 
 	/**
-	 * Enqueue front end assets.
+	 * Enqueues front end assets.
 	 */
 	public function enqueue_front() {
 		wp_enqueue_script( 'bp-xprofile-custom-field-types' );
@@ -133,7 +133,7 @@ public function enqueue_front() {
 	}
 
 	/**
-	 * Load vendor assets.
+	 * Loads vendor assets.
 	 */
 	public function enqueue_vendors() {
 		wp_enqueue_style( 'select2' );
@@ -144,7 +144,7 @@ public function enqueue_vendors() {
 	}
 
 	/**
-	 * Enqueue admin assets for add/edit field screen..
+	 * Enqueues admin assets for add/edit field screen.
 	 */
 	public function enqueue_admin() {
 		wp_enqueue_script( 'bp-xprofile-custom-field-types-admin' );
@@ -155,15 +155,15 @@ public function enqueue_admin() {
 	}
 
 	/**
-	 * Enqueue admin assets needed for user profile edit page.
+	 * Enqueues admin assets needed for user profile edit page.
 	 */
 	public function enqueue_user_admin() {
 		wp_enqueue_script( 'bp-xprofile-custom-field-types' );
 		wp_localize_script( 'bp-xprofile-custom-field-types', 'BPXprofileCFTR', $this->data );
 	}
 
 	/**
-	 * Register vendor scripts.
+	 * Registers vendor scripts.
 	 */
 	private function register_vendors() {
 
@@ -188,7 +188,7 @@ private function register_vendors() {
 	}
 
 	/**
-	 * Register core assets.
+	 * Registers core assets.
 	 */
 	private function register_core() {
 		$url     = bp_xprofile_cftr()->url;
@@ -202,7 +202,7 @@ private function register_core() {
 	}
 
 	/**
-	 * Register core assets.
+	 * Registers core assets.
 	 */
 	private function register_admin() {
 		$url     = bp_xprofile_cftr()->url;
@@ -236,5 +236,4 @@ private function should_load_front_assets() {
 
 		return apply_filters( 'bpxcftr_load_front_assets', $load );
 	}
-
 }

src/bootstrap/class-autoloader.php

@@ -16,7 +16,7 @@
 defined( 'ABSPATH' ) || exit;
 
 /**
- * Auto Loader for ReportAbuse.
+ * Auto Loader for BuddyPress Xprofile Custom Field Types.
  *
  * After registering this autoload function with SPL, the following line
  * would cause the function to attempt to load the BPXProfileCFTR\Bar\Baz\Qux class

src/bootstrap/class-bootstrapper.php

@@ -34,15 +34,15 @@
 class Bootstrapper {
 
 	/**
-	 * Setup the bootstrapper.
+	 * Sets up the bootstrapper.
 	 */
 	public static function boot() {
 		$self = new self();
 		$self->setup();
 	}
 
 	/**
-	 * Bind hooks
+	 * Binds hooks
 	 */
 	private function setup() {
 
@@ -54,7 +54,7 @@ private function setup() {
 	}
 
 	/**
-	 * Load core functions/template tags.
+	 * Loads core functions/template tags.
 	 * These are non auto loadable constructs.
 	 */
 	public function load() {
@@ -63,14 +63,14 @@ public function load() {
 	}
 
 	/**
-	 * Load translations.
+	 * Loads translations.
 	 */
 	public function load_translations() {
 		load_plugin_textdomain( 'bp-xprofile-custom-field-types', false, basename( dirname( bp_xprofile_cftr()->path ) ) . '/languages' );
 	}
 
 	/**
-	 * Register the field types.
+	 * Registers the field types.
 	 *
 	 * @param array $fields field types.
 	 *
@@ -82,7 +82,7 @@ public function register_field_types( $fields ) {
 	}
 
 	/**
-	 * Load files common to each request type.
+	 * Loads files common to each request type.
 	 */
 	private function load_common() {
 		$path = bp_xprofile_cftr()->path;
@@ -114,7 +114,7 @@ private function load_common() {
 	}
 
 	/**
-	 * Load admin.
+	 * Loads admin.
 	 */
 	private function load_admin() {
 

src/core/bp-xprofile-custom-field-types-functions.php

@@ -16,7 +16,7 @@
 defined( 'ABSPATH' ) || exit;
 
 /**
- * Get a mapping of field type to their implementation class.
+ * Returns a mapping of field types to their implementation class.
  *
  * @return array Key/value pairs (field type => class name).
  */
@@ -49,7 +49,7 @@ function bpxcftr_get_field_types() {
 }
 
 /**
- * Get field types which support the selec2  js.
+ * Returns field types which support the select2 js.
  *
  * @return array
  */
@@ -67,7 +67,7 @@ function bpxcftr_get_selectable_field_types() {
 	return apply_filters( 'bpxcftr_selectable_types', $types );
 }
 /**
- * Get an array of allowed file extensions.
+ * Returns an array of allowed file extensions.
  *
  * @param string $type possible values 'image', 'file'.
  *
@@ -95,7 +95,7 @@ function bpxcftr_get_allowed_file_extensions( $type ) {
 }
 
 /**
- * Get maximum allowed file size.
+ * Returns maximum allowed file size.
  *
  * @param string $type field type.
  *
@@ -142,7 +142,7 @@ function bpxcftr_is_multi_valued_field( $field ) {
 }
 
 /**
- * It is a work around to get the field at the time is_valid() is called on field types.
+ * It is a workaround to get the field at the time is_valid() is called on field types.
  * BuddyPress does not pass the id at the moment.
  *
  * @return BP_XProfile_Field|null
@@ -152,7 +152,7 @@ function bpxcftr_get_current_field() {
 }
 
 /**
- * Save the current field value.
+ * Saves the current field value.
  *
  * @param BP_XProfile_Field|null $field field object or null.
  */

src/core/class-data-store.php

@@ -28,7 +28,7 @@ class Data_Store {
 	private $data = array();
 
 	/**
-	 * Get the property value.
+	 * returns the property's value.
 	 *
 	 * @param string $name dynamic property name.
 	 *
@@ -39,7 +39,7 @@ public function __get( $name ) {
 	}
 
 	/**
-	 * Check if a property is set.
+	 * Checks if a property is set.
 	 *
 	 * @param string $name property name.
 	 *
@@ -50,7 +50,7 @@ public function __isset( $name ) {
 	}
 
 	/**
-	 * Set a property.
+	 * Sets a property.
 	 *
 	 * @param string $name property name.
 	 * @param mixed  $value value.
@@ -60,7 +60,7 @@ public function __set( $name, $value ) {
 	}
 
 	/**
-	 * Unset a property.
+	 * Unsets a property.
 	 *
 	 * @param string $name property name.
 	 */