Skip to content

Commit bc35d72

Browse files
atimmeratimmer
committed
Docs: Remove @summary tags from JSDoc.
As decided in the JavaScript core chat. With a few reasons: * It is visually cleaner when reading the source. * This bring the JavaScript documentation closer to the PHP documentation. The only disadvantage is that the JSDoc parser doesn't split out the summary and the description in the new format. We've decided to solve this when building the JavaScript documentation parser. Props herregroen. Fixes #42901. git-svn-id: https://develop.svn.wordpress.org/trunk@42411 602fd350-edb4-49c9-b593-d223f7449a82
1 parent 05d60c5 commit bc35d72

24 files changed

Lines changed: 338 additions & 371 deletions

‎src/wp-admin/js/color-picker.js‎

Lines changed: 7 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@
1010
_wrappingLabelText = '<span class="screen-reader-text"></span>';
1111

1212
/**
13-
* @summary Creates a jQuery UI color picker.
14-
*
1513
* Creates a jQuery UI color picker that is used in the theme customizer.
1614
*
1715
* @class $.widget.wp.wpColorPicker
@@ -31,7 +29,7 @@
3129
slider: 'horizontal'
3230
},
3331
/**
34-
* @summary Creates a color picker that only allows you to adjust the hue.
32+
* Creates a color picker that only allows you to adjust the hue.
3533
*
3634
* @since 3.5.0
3735
*
@@ -56,7 +54,7 @@
5654
hide: false,
5755
color: color,
5856
/**
59-
* @summary Handles the onChange event if one has been defined in the options.
57+
* Handles the onChange event if one has been defined in the options.
6058
*
6159
* @ignore
6260
*
@@ -75,8 +73,6 @@
7573
} );
7674
},
7775
/**
78-
* @summary Creates the color picker.
79-
*
8076
* Creates the color picker, sets default values, css classes and wraps it all in HTML.
8177
*
8278
* @since 3.5.0
@@ -176,8 +172,6 @@
176172
mode: self.options.mode,
177173
palettes: self.options.palettes,
178174
/**
179-
* @summary Handles the onChange event if one has been defined in the options.
180-
*
181175
* Handles the onChange event if one has been defined in the options and additionally
182176
* sets the background color for the toggler element.
183177
*
@@ -208,7 +202,7 @@
208202
}
209203
},
210204
/**
211-
* @summary Binds event listeners to the color picker.
205+
* Binds event listeners to the color picker.
212206
*
213207
* @since 3.5.0
214208
*
@@ -220,7 +214,7 @@
220214
var self = this;
221215

222216
/**
223-
* @summary Prevent any clicks inside this widget from leaking to the top and closing it.
217+
* Prevent any clicks inside this widget from leaking to the top and closing it.
224218
*
225219
* @since 3.5.0
226220
*
@@ -233,7 +227,7 @@
233227
});
234228

235229
/**
236-
* @summary Open or close the color picker depending on the class.
230+
* Open or close the color picker depending on the class.
237231
*
238232
* @since 3.5
239233
*/
@@ -246,8 +240,6 @@
246240
});
247241

248242
/**
249-
* @summary Checks if value is empty when changing the color in the color picker.
250-
*
251243
* Checks if value is empty when changing the color in the color picker.
252244
* If so, the background color is cleared.
253245
*
@@ -271,8 +263,6 @@
271263
});
272264

273265
/**
274-
* @summary Enables the user to clear or revert the color in the color picker.
275-
*
276266
* Enables the user to either clear the color in the color picker or revert back to the default color.
277267
*
278268
* @since 3.5.0
@@ -295,7 +285,7 @@
295285
});
296286
},
297287
/**
298-
* @summary Opens the color picker dialog.
288+
* Opens the color picker dialog.
299289
*
300290
* @since 3.5.0
301291
*
@@ -311,7 +301,7 @@
311301
$( 'body' ).trigger( 'click.wpcolorpicker' ).on( 'click.wpcolorpicker', this.close );
312302
},
313303
/**
314-
* @summary Closes the color picker dialog.
304+
* Closes the color picker dialog.
315305
*
316306
* @since 3.5.0
317307
*
@@ -327,8 +317,6 @@
327317
$( 'body' ).off( 'click.wpcolorpicker', this.close );
328318
},
329319
/**
330-
* @summary Returns iris object or sets new color.
331-
*
332320
* Returns the iris object if no new color is provided. If a new color is provided, it sets the new color.
333321
*
334322
* @param newColor {string|*} The new color to use. Can be undefined.
@@ -344,8 +332,6 @@
344332
this.element.iris( 'option', 'color', newColor );
345333
},
346334
/**
347-
* @summary Returns iris object or sets new default color.
348-
*
349335
* Returns the iris object if no new default color is provided.
350336
* If a new default color is provided, it sets the new default color.
351337
*

‎src/wp-admin/js/comment.js‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/* global postboxes, commentL10n */
22

33
/**
4-
* @summary Binds to the document ready event.
4+
* Binds to the document ready event.
55
*
66
* @since 2.5.0
77
*
@@ -18,7 +18,7 @@ jQuery(document).ready( function($) {
1818
$edittimestamp = $timestampdiv.siblings( 'a.edit-timestamp' );
1919

2020
/**
21-
* @summary Adds event that opens the time stamp form if the form is hidden.
21+
* Adds event that opens the time stamp form if the form is hidden.
2222
*
2323
* @listens $edittimestamp:click
2424
*
@@ -37,7 +37,7 @@ jQuery(document).ready( function($) {
3737
});
3838

3939
/**
40-
* @summary Resets the time stamp values when the cancel button is clicked.
40+
* Resets the time stamp values when the cancel button is clicked.
4141
*
4242
* @listens .cancel-timestamp:click
4343
*
@@ -59,7 +59,7 @@ jQuery(document).ready( function($) {
5959
});
6060

6161
/**
62-
* @summary Sets the time stamp values when the ok button is clicked.
62+
* Sets the time stamp values when the ok button is clicked.
6363
*
6464
* @listens .save-timestamp:click
6565
*

0 commit comments

Comments
 (0)