WebDevStudios / CMB2

includes/CMB2_REST.php

Doc Comments +4 added lines, -1 removed lines

@@ -152,7 +152,7 @@ 
 	/**
 	 * Handler for updating custom field data.
 	 * @since  2.2.0
-	 * @param  mixed    $value    The value of the field
+	 * @param  mixed    $values    The value of the field
 	 * @param  object   $object   The object from the response
 	 * @param  string   $field_id Name of field
 	 * @return bool|int
@@ -233,6 +233,9 @@ 
 		return $protected;
 	}
 
+	/**
+	 * @param string $field_id
+	 */
 	public function field_can_update( $field_id ) {
 
 		$field        = $this->cmb->get_field( $field_id );

includes/CMB2.php

Doc Comments +3 added lines, -3 removed lines

@@ -620,7 +620,7 @@ 
 	/**
 	 * Save a repeatable group
 	 * @since  1.x.x
-	 * @param  array $field_group CMB2_Field group field object
+	 * @param  CMB2_Field $field_group CMB2_Field group field object
 	 * @return mixed              Return of CMB2_Field::update_data()
 	 */
 	public function save_group_field( $field_group ) {
@@ -910,7 +910,7 @@ 
 	 * @param  mixed  $field_id     Field (or group field) ID
 	 * @param  mixed  $field_args   Array of field arguments
 	 * @param  mixed  $sub_field_id Sub field ID (if field_group exists)
-	 * @param  mixed  $field_group  If a sub-field, will be the parent group CMB2_Field object
+	 * @param  CMB2_Field|null  $field_group  If a sub-field, will be the parent group CMB2_Field object
 	 * @return array                Array of CMB2_Field arguments
 	 */
 	public function get_field_args( $field_id, $field_args, $sub_field_id, $field_group ) {
@@ -969,7 +969,7 @@ 
 	 * @since  2.0.0
 	 * @param  array  $field           Metabox field config array
 	 * @param  int    $position        (optional) Position of metabox. 1 for first, etc
-	 * @return mixed                   Field id or false
+	 * @return string                   Field id or false
 	 */
 	public function add_field( array $field, $position = 0 ) {
 		if ( ! is_array( $field ) || ! array_key_exists( 'id', $field ) ) {

includes/CMB2_REST_Controller.php

Doc Comments +4 added lines, -2 removed lines

@@ -94,7 +94,6 @@ 
 	 *
 	 * @since 2.2.0
 	 *
-	 * @param  mixed $data
 	 * @return array $data
 	 */
 	public function prepare_item( $post ) {
@@ -107,7 +106,7 @@ 
 	 * @since  2.2.0
 	 *
 	 * @param  mixed $cb Callable function/method.
-	 * @return mixed     Results of output buffer after calling function/method.
+	 * @return string     Results of output buffer after calling function/method.
 	 */
 	public function get_cb_results( $cb ) {
 		$args = func_get_args();
@@ -142,6 +141,9 @@ 
 		return apply_filters( 'cmb2_rest_prepare', rest_ensure_response( $data ), $this->request, $this );
 	}
 
+	/**
+	 * @param string $request_type
+	 */
 	protected function initiate_rest_read_box( $request, $request_type ) {
 		$this->initiate_rest_box( $request, $request_type );
 

Indentation +14 added lines, -14 removed lines

@@ -1,19 +1,19 @@
 <?php
 /**
- * Creates CMB2 objects/fields endpoint for WordPres REST API.
- * Allows access to fields registered to a specific post type and more.
- *
- * @todo  Add better documentation.
- * @todo  Research proper schema.
- *
- * @since 2.2.0
- *
- * @category  WordPress_Plugin
- * @package   CMB2
- * @author    WebDevStudios
- * @license   GPL-2.0+
- * @link      http://webdevstudios.com
- */
+	 * Creates CMB2 objects/fields endpoint for WordPres REST API.
+	 * Allows access to fields registered to a specific post type and more.
+	 *
+	 * @todo  Add better documentation.
+	 * @todo  Research proper schema.
+	 *
+	 * @since 2.2.0
+	 *
+	 * @category  WordPress_Plugin
+	 * @package   CMB2
+	 * @author    WebDevStudios
+	 * @license   GPL-2.0+
+	 * @link      http://webdevstudios.com
+	 */
 abstract class CMB2_REST_Controller extends WP_REST_Controller {
 
 	/**

includes/CMB2_REST_Controller_Boxes.php

Doc Comments -1 removed lines

@@ -100,7 +100,6 @@
 	 *
 	 * @since 2.2.0
 	 *
-	 * @param CMB2 $cmb
 	 * @return array
 	 */
 	public function get_rest_box() {