Changeset 43332

Timestamp:

06/07/2018 02:39:43 PM (6 years ago)

Author:

atimmer

Message:

Docs: Improve JSDoc for admin-bar.js.

Props manuelaugustin, terwdan, sjardo, LisanneKluitmans.
Fixes #43871.

File:

• trunk/src/js/_enqueues/lib/admin-bar.js (modified) (21 diffs)

trunk/src/js/_enqueues/lib/admin-bar.js

@@ -11 +11 @@
         var adminbar = $('#wpadminbar'), refresh, touchOpen, touchClose, disableHoverIntent = false;
 
-        refresh = function(i, el){ // force the browser to refresh the tabbing index
+        /**
+         * Forces the browser to refresh the tabbing index.
+         *
+         * @since 3.3.0
+         *
+         * @param {number}      i  The index of the HTML element to remove the tab index
+         *                         from. This parameter is necessary because we use this
+         *                         function in .each calls.
+         * @param {HTMLElement} el The HTML element to remove the tab index from.
+         *
+         * @return {void}
+         */
+        refresh = function(i, el){
             var node = $(el), tab = node.attr('tabindex');
             if ( tab )
@@ -17 +29 @@
         };
 
+
+
+
+
+
+
+
+
+
         touchOpen = function(unbind) {
             adminbar.find('li.menupop').on('click.wp-mobile-hover', function(e) {
@@ -44 +65 @@
         };
 
+
+
+
+
+
+
+
         touchClose = function() {
             var mobileEvent = /Mobile\/.+Safari/.test(navigator.userAgent) ? 'touchstart' : 'click';
@@ -55 +83 @@
         adminbar.removeClass('nojq').removeClass('nojs');
 
+
+
         if ( 'ontouchstart' in window ) {
             adminbar.on('touchstart', function(){
@@ -66 +96 @@
         }
 
+
         adminbar.find('li.menupop').hoverIntent({
             over: function() {
@@ -84 +115 @@
         });
 
+
+
         if ( window.location.hash )
             window.scrollBy( 0, -32 );
 
+
+
+
+
+
+
+
+
+
+
         $('#wp-admin-bar-get-shortlink').click(function(e){
             e.preventDefault();
@@ -94 +137 @@
         });
 
+
+
+
+
+
+
+
+
+
+
         $('#wpadminbar li.menupop > .ab-item').bind('keydown.adminbar', function(e){
+
             if ( e.which != 13 )
                 return;
@@ -117 +171 @@
         }).each(refresh);
 
+
+
+
+
+
+
+
+
+
+
         $('#wpadminbar .ab-item').bind('keydown.adminbar', function(e){
+
             if ( e.which != 27 )
                 return;
@@ -130 +195 @@
         });
 
+
+
+
+
+
+
+
         adminbar.click( function(e) {
             if ( e.target.id != 'wpadminbar' && e.target.id != 'wp-admin-bar-top-secondary' ) {
@@ -140 +212 @@
         });
 
-        // fix focus bug in WebKit
+        /**
+         * Sets the focus on an element with a href attribute.
+         *
+         * The timeout is used to fix a focus bug in WebKit.
+         *
+         * @param {Object} e The keydown event.
+         *
+         * @return {void}
+         */
         $('.screen-reader-shortcut').keydown( function(e) {
             var id, ua;
@@ -159 +239 @@
 
         $( '#adminbar-search' ).on({
+
+
+
+
+
             focus: function() {
                 $( '#adminbarsearch' ).addClass( 'adminbar-focused' );
+
+
+
+
+
             }, blur: function() {
                 $( '#adminbarsearch' ).removeClass( 'adminbar-focused' );
@@ -166 +256 @@
         } );
 
-        // Empty sessionStorage on logging out
         if ( 'sessionStorage' in window ) {
+
+
+
+
+
             $('#wp-admin-bar-logout a').click( function() {
                 try {
@@ -185 +279 @@
     });
 } else {
+
+
+
+
+
+
+
+
     (function(d, w) {
+
+
+
+
+
+
+
+
+
+
+
         var addEvent = function( obj, type, fn ) {
             if ( obj.addEventListener )
@@ -197 +310 @@
 
         /**
-         * Get the timeout ID of the given element
+         * Gets the timeout ID of the given element.
+         *
+         * @since 3.1.0
+         *
+         * @param {HTMLElement} el The HTML element.
+         *
+         * @return {number|boolean} The ID value of the timer that is set or false.
          */
         getTOID = function(el) {
@@ -208 +327 @@
         },
 
+
+
+
+
+
+
+
+
+
         addHoverClass = function(t) {
             var i, id, inA, hovering, ul, li,
@@ -213 +341 @@
                 ancestorLength = 0;
 
+
             while ( t && t != aB && t != d ) {
                 if ( 'LI' == t.nodeName.toUpperCase() ) {
@@ -225 +354 @@
             }
 
-            // Remove any selected classes.
+            // Remove any selected classes.
             if ( hovering && hovering.parentNode ) {
                 ul = hovering.parentNode;
@@ -238 +367 @@
             }
 
-            /* remove the hover class for any objects not in the immediate element's ancestry */
+            /
             i = q.length;
             while ( i-- ) {
@@ -253 +382 @@
         },
 
+
+
+
+
+
+
+
+
+
         removeHoverClass = function(t) {
             while ( t && t != aB && t != d ) {
@@ -267 +405 @@
         },
 
+
+
+
+
+
+
+
+
+
         clickShortlink = function(e) {
             var i, l, node,
@@ -305 +452 @@
         },
 
+
+
+
+
+
+
+
+
+
         scrollToTop = function(t) {
             var distance, speed, step, steps, timer, speed_step;