Completed
Pull Request — trunk (#541)
by Justin
12:21 queued 08:58
created
includes/CMB2_hookup.php 1 patch
Doc Comments   +1 added lines, -1 removed lines patch added patch discarded remove patch
@@ -267,7 +267,7 @@
 block discarded – undo
267 267
 	 * Add 'closed' class to metabox
268 268
 	 * @since  2.0.0
269 269
 	 * @param  array  $classes Array of classes
270
-	 * @return array           Modified array of classes
270
+	 * @return string[]           Modified array of classes
271 271
 	 */
272 272
 	public function close_metabox_class( $classes ) {
273 273
 		$classes[] = 'closed';
Please login to merge, or discard this patch.
includes/CMB2_Sanitize.php 1 patch
Doc Comments   +3 added lines patch added patch discarded remove patch
@@ -357,6 +357,7 @@  discard block
 block discarded – undo
357 357
 	/**
358 358
 	 * Gets the values for the `file` field type from the data being saved.
359 359
 	 * @since  2.2.0
360
+	 * @param string $id_key
360 361
 	 */
361 362
 	public function _get_group_file_value_array( $id_key ) {
362 363
 		$alldata = $this->field->group->data_to_save;
@@ -378,6 +379,7 @@  discard block
 block discarded – undo
378 379
 	/**
379 380
 	 * Peforms saving of `file` attachement's ID
380 381
 	 * @since  1.1.0
382
+	 * @param string $file_id_key
381 383
 	 */
382 384
 	public function _save_file_id_value( $file_id_key ) {
383 385
 		$id_field = $this->_new_supporting_field( $file_id_key );
@@ -398,6 +400,7 @@  discard block
 block discarded – undo
398 400
 	/**
399 401
 	 * Peforms saving of `text_datetime_timestamp_timezone` utc timestamp
400 402
 	 * @since  2.2.0
403
+	 * @param string $utc_key
401 404
 	 */
402 405
 	public function _save_utc_value( $utc_key, $utc_stamp ) {
403 406
 		return $this->_new_supporting_field( $utc_key )->save_field( $utc_stamp );
Please login to merge, or discard this patch.
includes/CMB2_REST.php 1 patch
Doc Comments   +4 added lines, -1 removed lines patch added patch discarded remove patch
@@ -152,7 +152,7 @@  discard block
 block discarded – undo
152 152
 	/**
153 153
 	 * Handler for updating custom field data.
154 154
 	 * @since  2.2.0
155
-	 * @param  mixed    $value    The value of the field
155
+	 * @param  mixed    $values    The value of the field
156 156
 	 * @param  object   $object   The object from the response
157 157
 	 * @param  string   $field_id Name of field
158 158
 	 * @return bool|int
@@ -233,6 +233,9 @@  discard block
 block discarded – undo
233 233
 		return $protected;
234 234
 	}
235 235
 
236
+	/**
237
+	 * @param string $field_id
238
+	 */
236 239
 	public function field_can_update( $field_id ) {
237 240
 
238 241
 		$field        = $this->cmb->get_field( $field_id );
Please login to merge, or discard this patch.
includes/CMB2_REST_Controller.php 1 patch
Doc Comments   +4 added lines, -2 removed lines patch added patch discarded remove patch
@@ -94,7 +94,6 @@  discard block
 block discarded – undo
94 94
 	 *
95 95
 	 * @since 2.2.0
96 96
 	 *
97
-	 * @param  mixed $data
98 97
 	 * @return array $data
99 98
 	 */
100 99
 	public function prepare_item( $post ) {
@@ -107,7 +106,7 @@  discard block
 block discarded – undo
107 106
 	 * @since  2.2.0
108 107
 	 *
109 108
 	 * @param  mixed $cb Callable function/method.
110
-	 * @return mixed     Results of output buffer after calling function/method.
109
+	 * @return string     Results of output buffer after calling function/method.
111 110
 	 */
112 111
 	public function get_cb_results( $cb ) {
113 112
 		$args = func_get_args();
@@ -142,6 +141,9 @@  discard block
 block discarded – undo
142 141
 		return apply_filters( 'cmb2_rest_prepare', rest_ensure_response( $data ), $this->request, $this );
143 142
 	}
144 143
 
144
+	/**
145
+	 * @param string $request_type
146
+	 */
145 147
 	protected function initiate_rest_read_box( $request, $request_type ) {
146 148
 		$this->initiate_rest_box( $request, $request_type );
147 149
 
Please login to merge, or discard this patch.
includes/CMB2_REST_Controller_Boxes.php 1 patch
Doc Comments   -1 removed lines patch added patch discarded remove patch
@@ -100,7 +100,6 @@
 block discarded – undo
100 100
 	 *
101 101
 	 * @since 2.2.0
102 102
 	 *
103
-	 * @param CMB2 $cmb
104 103
 	 * @return array
105 104
 	 */
106 105
 	public function get_rest_box() {
Please login to merge, or discard this patch.
includes/CMB2_Ajax.php 1 patch
Doc Comments   +1 added lines, -2 removed lines patch added patch discarded remove patch
@@ -30,7 +30,7 @@  discard block
 block discarded – undo
30 30
 	/**
31 31
 	 * Get the singleton instance of this class
32 32
 	 * @since 2.2.2
33
-	 * @return object
33
+	 * @return CMB2_Ajax
34 34
 	 */
35 35
 	public static function get_instance() {
36 36
 		if ( ! ( self::$instance instanceof self ) ) {
@@ -221,7 +221,6 @@  discard block
 block discarded – undo
221 221
 	 *
222 222
 	 * @since  1.3.0
223 223
 	 * @param  string  $meta_key   Postmeta's key
224
-	 * @param  mixed   $meta_value (Optional) value of the postmeta to be saved
225 224
 	 */
226 225
 	protected function cache_action( $meta_key ) {
227 226
 		$func_args = func_get_args();
Please login to merge, or discard this patch.
includes/types/CMB2_Type_Base.php 1 patch
Doc Comments   +1 added lines, -2 removed lines patch added patch discarded remove patch
@@ -84,7 +84,6 @@  discard block
 block discarded – undo
84 84
 
85 85
 	/**
86 86
 	 * Fall back to CMB2_Types methods
87
-	 * @param string $field
88 87
 	 * @throws Exception Throws an exception if the field is invalid.
89 88
 	 * @return mixed
90 89
 	 */
@@ -105,7 +104,7 @@  discard block
 block discarded – undo
105 104
 	 * Magic getter for our object.
106 105
 	 * @param string $field
107 106
 	 * @throws Exception Throws an exception if the field is invalid.
108
-	 * @return mixed
107
+	 * @return CMB2_Field
109 108
 	 */
110 109
 	public function __get( $field ) {
111 110
 		switch ( $field ) {
Please login to merge, or discard this patch.
includes/types/CMB2_Type_Text_Datetime_Timestamp.php 1 patch
Doc Comments   +6 added lines patch added patch discarded remove patch
@@ -38,6 +38,9 @@  discard block
 block discarded – undo
38 38
 		return $date_input . "\n" . $time_input;
39 39
 	}
40 40
 
41
+	/**
42
+	 * @param boolean $has_good_value
43
+	 */
41 44
 	public function date_args( $args, $has_good_value ) {
42 45
 		$date_args = wp_parse_args( $args['datepicker'], array(
43 46
 			'class' => 'cmb2-text-small cmb2-datepicker',
@@ -51,6 +54,9 @@  discard block
 block discarded – undo
51 54
 		return $this->parse_picker_options( 'date', $date_args );
52 55
 	}
53 56
 
57
+	/**
58
+	 * @param boolean $has_good_value
59
+	 */
54 60
 	public function time_args( $args, $has_good_value ) {
55 61
 		$time_args = wp_parse_args( $args['timepicker'], array(
56 62
 			'class' => 'cmb2-timepicker text-time',
Please login to merge, or discard this patch.
includes/types/CMB2_Type_Wysiwyg.php 1 patch
Doc Comments   -1 removed lines patch added patch discarded remove patch
@@ -15,7 +15,6 @@
 block discarded – undo
15 15
 	/**
16 16
 	 * Handles outputting a 'wysiwyg' element
17 17
 	 * @since  1.1.0
18
-	 * @param  array  $args Override arguments
19 18
 	 * @return string       Form wysiwyg element
20 19
 	 */
21 20
 	public function render() {
Please login to merge, or discard this patch.