Changeset 41314

Timestamp:

08/24/2017 05:57:18 PM (6 years ago)

Author:

wonderboymusic

Message:

Docs: improve JS docs for comment-reply.js

Props andizer, ireneyoast.
Fixes #41548.

File:

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

trunk/src/wp-includes/js/comment-reply.js

@@ +1 @@
+/**
+ * @summary Handles the addition of the comment form.
+ *
+ * @since 2.7.0
+ *
+ * @type {Object}
+ */
 var addComment = {
+    /**
+     * @summary Retrieves the elements corresponding to the given IDs.
+     *
+     * @since 2.7.0
+     *
+     * @param {string} commId The comment ID.
+     * @param {string} parentId The parent ID.
+     * @param {string} respondId The respond ID.
+     * @param {string} postId The post ID.
+     * @returns {boolean} Always returns false.
+     */
     moveForm: function( commId, parentId, respondId, postId ) {
         var div, element, style, cssHidden,
@@ -31 +49 @@
         cancel.style.display = '';
 
+        /**
+         * @summary Puts back the comment, hides the cancel button and removes the onclick event.
+         *
+         * @returns {boolean} Always returns false.
+         */
         cancel.onclick = function() {
             var t       = addComment,
@@ -49 +72 @@
 
         /*
-         * Set initial focus to the first form focusable element.
-         * Try/catch used just to avoid errors in IE 7- which return visibility
+         * Sets initial focus to the first form focusable element.
+         * Uses try/catch just to avoid errors in IE 7- which return visibility
          * 'inherit' when the visibility value is inherited from an ancestor.
          */
@@ -91 +114 @@
     },
 
+    /**
+     * @summary Returns the object corresponding to the given ID.
+     *
+     * @since 2.7.0
+     *
+     * @param {string} id The ID.
+     * @returns {Element} The element belonging to the ID.
+     */
     I: function( id ) {
         return document.getElementById( id );