Changeset 40913

Timestamp:

06/15/2017 01:01:30 PM (8 years ago)

Author:

SergeyBiryukov

Message:

Docs: Add documentation for wp-admin/js/comment.js.

Props ireneyoast, andizer, jipmoors.
Fixes #41065.

File:

• trunk/src/wp-admin/js/comment.js (modified) (4 diffs)

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

@@ -1 +1 @@
 /* global postboxes, commentL10n */
+
+/**
+ * @summary Binds to the document ready event.
+ *
+ * @since 2.5.0
+ *
+ * @param {jQuery} $ The jQuery object.
+ */
 jQuery(document).ready( function($) {
 
@@ -10 +18 @@
         $edittimestamp = $timestampdiv.siblings( 'a.edit-timestamp' );
 
+    /**
+     * @summary Adds event that opens the time stamp form if the form is hidden.
+     *
+     * @listens $edittimestamp:click
+     *
+     * @param {Event} event The event object.
+     * @returns {void}
+     */
     $edittimestamp.click( function( event ) {
         if ( $timestampdiv.is( ':hidden' ) ) {
+            // Slide down the form and set focus on the first field.
             $timestampdiv.slideDown( 'fast', function() {
                 $( 'input, select', $timestampwrap ).first().focus();
@@ -19 +36 @@
         event.preventDefault();
     });
+
+    /**
+     * @summary Resets the time stamp values when the cancel button is clicked.
+     *
+     * @listens .cancel-timestamp:click
+     *
+     * @param {Event} event The event object.
+     * @returns {void}
+     */
 
     $timestampdiv.find('.cancel-timestamp').click( function( event ) {
@@ -33 +59 @@
     });
 
+    /**
+     * @summary Sets the time stamp values when the ok button is clicked.
+     *
+     * @listens .save-timestamp:click
+     *
+     * @param {Event} event The event object.
+     * @returns {void}
+     */
     $timestampdiv.find('.save-timestamp').click( function( event ) { // crazyhorse - multiple ok cancels
         var aa = $('#aa').val(), mm = $('#mm').val(), jj = $('#jj').val(), hh = $('#hh').val(), mn = $('#mn').val(),