Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-09-27 06:42:56 +02:00
Code Issues Projects Releases Wiki Activity

Docs: Remove @summary tags from JSDoc.

Browse Source 
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.

Built from https://develop.svn.wordpress.org/trunk@42411


git-svn-id: http://core.svn.wordpress.org/trunk@42240 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
atimmer 2017-12-18 14:14:53 +00:00
parent 65b715c991
commit f6a37e7d39
23 changed files with 323 additions and 354 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
wp-admin/js/color-picker.js
View File

@ -10,8 +10,6 @@
_wrappingLabelText = '<span class="screen-reader-text"></span>';
/**
* @summary Creates a jQuery UI color picker.
*
* Creates a jQuery UI color picker that is used in the theme customizer.
*
* @class $.widget.wp.wpColorPicker
@ -31,7 +29,7 @@
slider: 'horizontal'
},
/**
* @summary Creates a color picker that only allows you to adjust the hue.
* Creates a color picker that only allows you to adjust the hue.
*
* @since 3.5.0
*
@ -56,7 +54,7 @@
hide: false,
color: color,
/**
* @summary Handles the onChange event if one has been defined in the options.
* Handles the onChange event if one has been defined in the options.
*
* @ignore
*
@ -75,8 +73,6 @@
} );
},
/**
* @summary Creates the color picker.
*
* Creates the color picker, sets default values, css classes and wraps it all in HTML.
*
* @since 3.5.0
@ -176,8 +172,6 @@
mode: self.options.mode,
palettes: self.options.palettes,
/**
* @summary Handles the onChange event if one has been defined in the options.
*
* Handles the onChange event if one has been defined in the options and additionally
* sets the background color for the toggler element.
*
@ -208,7 +202,7 @@
}
},
/**
* @summary Binds event listeners to the color picker.
* Binds event listeners to the color picker.
*
* @since 3.5.0
*
@ -220,7 +214,7 @@
var self = this;
/**
* @summary Prevent any clicks inside this widget from leaking to the top and closing it.
* Prevent any clicks inside this widget from leaking to the top and closing it.
*
* @since 3.5.0
*
@ -233,7 +227,7 @@
});
/**
* @summary Open or close the color picker depending on the class.
* Open or close the color picker depending on the class.
*
* @since 3.5
*/
@ -246,8 +240,6 @@
});
/**
* @summary Checks if value is empty when changing the color in the color picker.
*
* Checks if value is empty when changing the color in the color picker.
* If so, the background color is cleared.
*
@ -271,8 +263,6 @@
});
/**
* @summary Enables the user to clear or revert the color in the color picker.
*
* Enables the user to either clear the color in the color picker or revert back to the default color.
*
* @since 3.5.0
@ -295,7 +285,7 @@
});
},
/**
* @summary Opens the color picker dialog.
* Opens the color picker dialog.
*
* @since 3.5.0
*
@ -311,7 +301,7 @@
$( 'body' ).trigger( 'click.wpcolorpicker' ).on( 'click.wpcolorpicker', this.close );
},
/**
* @summary Closes the color picker dialog.
* Closes the color picker dialog.
*
* @since 3.5.0
*
@ -327,8 +317,6 @@
$( 'body' ).off( 'click.wpcolorpicker', this.close );
},
/**
* @summary Returns iris object or sets new color.
*
* Returns the iris object if no new color is provided. If a new color is provided, it sets the new color.
*
* @param newColor {string|*} The new color to use. Can be undefined.
@ -344,8 +332,6 @@
this.element.iris( 'option', 'color', newColor );
},
/**
* @summary Returns iris object or sets new default color.
*
* Returns the iris object if no new default color is provided.
* If a new default color is provided, it sets the new default color.
*

8
wp-admin/js/comment.js
View File

@ -1,7 +1,7 @@
/* global postboxes, commentL10n */
/**
* @summary Binds to the document ready event.
* Binds to the document ready event.
*
* @since 2.5.0
*
@ -18,7 +18,7 @@ jQuery(document).ready( function($) {
$edittimestamp = $timestampdiv.siblings( 'a.edit-timestamp' );
/**
* @summary Adds event that opens the time stamp form if the form is hidden.
* Adds event that opens the time stamp form if the form is hidden.
*
* @listens $edittimestamp:click
*
@ -37,7 +37,7 @@ jQuery(document).ready( function($) {
});
/**
* @summary Resets the time stamp values when the cancel button is clicked.
* Resets the time stamp values when the cancel button is clicked.
*
* @listens .cancel-timestamp:click
*
@ -59,7 +59,7 @@ jQuery(document).ready( function($) {
});
/**
* @summary Sets the time stamp values when the ok button is clicked.
* Sets the time stamp values when the ok button is clicked.
*
* @listens .save-timestamp:click
*

128
wp-admin/js/common.js
View File

@ -2,7 +2,7 @@
var showNotice, adminMenu, columns, validateForm, screenMeta;
/**
* @summary Adds common WordPress functionality to the window.
* Adds common WordPress functionality to the window.
*
* @param {jQuery} $ jQuery object.
* @param {Object} window The window object.
@ -14,7 +14,7 @@ var showNotice, adminMenu, columns, validateForm, screenMeta;
$body = $( document.body );
/**
* @summary Removed in 3.3.0, needed for back-compatibility.
* Removed in 3.3.0, needed for back-compatibility.
*
* @since 2.7.0
* @deprecated 3.3.0
@ -31,7 +31,7 @@ adminMenu = {
columns = {
/**
* @summary Initializes the column toggles in the screen options.
* Initializes the column toggles in the screen options.
*
* Binds an onClick event to the checkboxes to show or hide the table columns
* based on their toggled state. And persists the toggled state.
@ -54,7 +54,7 @@ columns = {
},
/**
* @summary Saves the toggled state for the columns.
* Saves the toggled state for the columns.
*
* Saves whether the columns should be shown or hidden on a page.
*
@ -73,7 +73,7 @@ columns = {
},
/**
* @summary Makes a column visible and adjusts the column span for the table.
* Makes a column visible and adjusts the column span for the table.
*
* @since 3.0.0
* @param {string} column The column name.
@ -86,7 +86,7 @@ columns = {
},
/**
* @summary Hides a column and adjusts the column span for the table.
* Hides a column and adjusts the column span for the table.
*
* @since 3.0.0
* @param {string} column The column name.
@ -99,7 +99,7 @@ columns = {
},
/**
* @summary Get all hidden columns.
* Gets all hidden columns.
*
* @since 3.0.0
*
@ -112,7 +112,7 @@ columns = {
},
/**
* @summary Gets the checked column toggles from the screen options.
* Gets the checked column toggles from the screen options.
*
* @since 3.0.0
*
@ -128,7 +128,7 @@ columns = {
},
/**
* @summary Adjusts the column span for the table.
* Adjusts the column span for the table.
*
* @since 3.1.0
*
@ -146,7 +146,7 @@ columns = {
$document.ready(function(){columns.init();});
/**
* @summary Validates that the required form fields are not empty.
* Validates that the required form fields are not empty.
*
* @since 2.9.0
*
@ -166,7 +166,7 @@ validateForm = function( form ) {
// stub for doing better warnings
/**
* @summary Shows message pop-up notice or confirmation message.
* Shows message pop-up notice or confirmation message.
*
* @since 2.7.0
*
@ -177,7 +177,7 @@ validateForm = function( form ) {
showNotice = {
/**
* @summary Shows a delete confirmation pop-up message.
* Shows a delete confirmation pop-up message.
*
* @since 2.7.0
*
@ -193,7 +193,7 @@ showNotice = {
},
/**
* @summary Shows an alert message.
* Shows an alert message.
*
* @since 2.7.0
*
@ -205,7 +205,7 @@ showNotice = {
};
/**
* @summary Represents the functions for the meta screen options panel.
* Represents the functions for the meta screen options panel.
*
* @since 3.2.0
*
@ -221,7 +221,7 @@ screenMeta = {
page: null, // #wpcontent
/**
* @summary Initializes the screen meta options panel.
* Initializes the screen meta options panel.
*
* @since 3.2.0
*
@ -236,7 +236,7 @@ screenMeta = {
},
/**
* @summary Toggles the screen meta options panel.
* Toggles the screen meta options panel.
*
* @since 3.2.0
*
@ -255,7 +255,7 @@ screenMeta = {
},
/**
* @summary Opens the screen meta options panel.
* Opens the screen meta options panel.
*
* @since 3.2.0
*
@ -271,7 +271,7 @@ screenMeta = {
panel.parent().show();
/**
* @summary Sets the focus to the meta options panel and adds the necessary CSS classes.
* Sets the focus to the meta options panel and adds the necessary CSS classes.
*
* @since 3.2.0
*
@ -286,7 +286,7 @@ screenMeta = {
},
/**
* @summary Closes the screen meta options panel.
* Closes the screen meta options panel.
*
* @since 3.2.0
*
@ -297,7 +297,7 @@ screenMeta = {
*/
close: function( panel, button ) {
/**
* @summary Hides the screen meta options panel.
* Hides the screen meta options panel.
*
* @since 3.2.0
*
@ -314,7 +314,7 @@ screenMeta = {
};
/**
* @summary Initializes the help tabs in the help panel.
* Initializes the help tabs in the help panel.
*
* @param {Event} e The event object.
*
@ -495,7 +495,7 @@ $document.ready( function() {
$headerEnd = $( '.wp-header-end' );
/**
* @summary Makes the fly-out submenu header clickable, when the menu is folded.
* Makes the fly-out submenu header clickable, when the menu is folded.
*
* @param {Event} e The event object.
*
@ -506,7 +506,7 @@ $document.ready( function() {
});
/**
* @summary Collapses the admin menu.
* Collapses the admin menu.
*
* @returns {void}
*/
@ -543,7 +543,7 @@ $document.ready( function() {
});
/**
* @summary Handles the `aria-haspopup` attribute on the current menu item when it has a submenu.
* Handles the `aria-haspopup` attribute on the current menu item when it has a submenu.
*
* @since 4.4.0
*
@ -564,7 +564,7 @@ $document.ready( function() {
$document.on( 'wp-menu-state-set wp-collapse-menu wp-responsive-activate wp-responsive-deactivate', currentMenuItemHasPopup );
/**
* @summary Ensures an admin submenu is within the visual viewport.
* Ensures an admin submenu is within the visual viewport.
*
* @since 4.1.0
*
@ -605,7 +605,7 @@ $document.ready( function() {
mobileEvent = isIOS ? 'touchstart' : 'click';
/**
* @summary Closes any open submenus when touch/click is not on the menu.
* Closes any open submenus when touch/click is not on the menu.
*
* @param {Event} e The event object.
*
@ -622,7 +622,7 @@ $document.ready( function() {
});
/**
* @summary Handles the opening or closing the submenu based on the mobile click|touch event.
* Handles the opening or closing the submenu based on the mobile click|touch event.
*
* @param {Event} event The event object.
*
@ -651,7 +651,7 @@ $document.ready( function() {
$adminmenu.find( 'li.wp-has-submenu' ).hoverIntent({
/**
* @summary Opens the submenu when hovered over the menu item for desktops.
* Opens the submenu when hovered over the menu item for desktops.
*
* @returns {void}
*/
@ -675,7 +675,7 @@ $document.ready( function() {
},
/**
* @summary Closes the submenu when no longer hovering the menu item.
* Closes the submenu when no longer hovering the menu item.
*
* @returns {void}
*/
@ -693,7 +693,7 @@ $document.ready( function() {
});
/**
* @summary Opens the submenu on when focused on the menu item.
* Opens the submenu on when focused on the menu item.
*
* @param {Event} event The event object.
*
@ -708,7 +708,7 @@ $document.ready( function() {
$( event.target ).closest( 'li.menu-top' ).addClass( 'opensub' );
/**
* @summary Closes the submenu on blur from the menu item.
* Closes the submenu on blur from the menu item.
*
* @param {Event} event The event object.
*
@ -722,7 +722,7 @@ $document.ready( function() {
$( event.target ).closest( 'li.menu-top' ).removeClass( 'opensub' );
/**
* @summary Adjusts the size for the submenu.
* Adjusts the size for the submenu.
*
* @returns {void}
*/
@ -743,7 +743,7 @@ $document.ready( function() {
$( 'div.updated, div.error, div.notice' ).not( '.inline, .below-h2' ).insertAfter( $headerEnd );
/**
* @summary Make notices dismissible.
* Makes notices dismissible.
*
* @since 4.4.0
*
@ -776,7 +776,7 @@ $document.ready( function() {
screenMeta.init();
/**
* @summary Checks a checkbox.
* Checks a checkbox.
*
* This event needs to be delegated. Ticket #37973.
*
@ -807,7 +807,7 @@ $document.ready( function() {
var unchecked = $(this).closest('tbody').find(':checkbox').filter(':visible:enabled').not(':checked');
/**
* @summary Determines if all checkboxes are checked.
* Determines if all checkboxes are checked.
*
* @returns {boolean} Returns true if there are no unchecked checkboxes.
*/
@ -819,7 +819,7 @@ $document.ready( function() {
});
/**
* @summary Controls all the toggles on bulk toggle change.
* Controls all the toggles on bulk toggle change.
*
* When the bulk checkbox is changed, all the checkboxes in the tables are changed accordingly.
* When the shift-button is pressed while changing the bulk checkbox the checkboxes in the table are inverted.
@ -839,7 +839,7 @@ $document.ready( function() {
$table.children( 'tbody' ).filter(':visible')
.children().children('.check-column').find(':checkbox')
/**
* @summary Updates the checked state on the checkbox in the table.
* Updates the checked state on the checkbox in the table.
*
* @returns {boolean} True checks the checkbox, False unchecks the checkbox.
*/
@ -861,7 +861,7 @@ $document.ready( function() {
.children().children('.check-column').find(':checkbox')
/**
* @summary Syncs the bulk checkboxes on the top and bottom of the table.
* Syncs the bulk checkboxes on the top and bottom of the table.
*
* @returns {boolean} True checks the checkbox, False unchecks the checkbox.
*/
@ -877,7 +877,7 @@ $document.ready( function() {
});
/**
* @summary Shows row actions on focus of its parent container element or any other elements contained within.
* Shows row actions on focus of its parent container element or any other elements contained within.
*
* @returns {void}
*/
@ -910,7 +910,7 @@ $document.ready( function() {
});
/**
* @summary Handles tab keypresses in theme and plugin editor textareas.
* Handles tab keypresses in theme and plugin editor textareas.
*
* @param {Event} e The event object.
*
@ -964,7 +964,7 @@ $document.ready( function() {
if ( pageInput.length ) {
/**
* @summary Handles pagination variable when filtering the list table.
* Handles pagination variable when filtering the list table.
*
* Set the pagination argument to the first page when the post-filter form is submitted.
* This happens when pressing the 'filter' button on the list table page.
@ -986,7 +986,7 @@ $document.ready( function() {
}
/**
* @summary Resets the bulk actions when the search button is clicked.
* Resets the bulk actions when the search button is clicked.
*
* @returns {void}
*/
@ -995,7 +995,7 @@ $document.ready( function() {
});
/**
* @summary Scrolls into view when focus.scroll-into-view is triggered.
* Scrolls into view when focus.scroll-into-view is triggered.
*
* @param {Event} e The event object.
*
@ -1007,7 +1007,7 @@ $document.ready( function() {
});
/**
* @summary Disables the submit upload buttons when no data is entered.
* Disables the submit upload buttons when no data is entered.
*
* @returns {void}
*/
@ -1022,7 +1022,7 @@ $document.ready( function() {
input = form.find('input[type="file"]');
/**
* @summary Determines if any data is entered in any file upload input.
* Determines if any data is entered in any file upload input.
*
* @since 3.5.0
*
@ -1042,7 +1042,7 @@ $document.ready( function() {
})();
/**
* @summary Pins the menu while distraction-free writing is enabled.
* Pins the menu while distraction-free writing is enabled.
*
* @param {Event} event Event data.
*
@ -1187,7 +1187,7 @@ $document.ready( function() {
}
/**
* @summary Determines the height of certain elements.
* Determines the height of certain elements.
*
* @since 4.1.0
*
@ -1203,7 +1203,7 @@ $document.ready( function() {
}
/**
* @summary Unpins the menu.
* Unpins the menu.
*
* @since 4.1.0
*
@ -1223,7 +1223,7 @@ $document.ready( function() {
}
/**
* @summary Pins and unpins the menu when applicable.
* Pins and unpins the menu when applicable.
*
* @since 4.1.0
*
@ -1252,8 +1252,6 @@ $document.ready( function() {
}
/**
* @summary Changes properties of metaboxes and body.
*
* Changes the sortables and responsiveness of metaboxes.
*
* @since 3.8.0
@ -1263,7 +1261,7 @@ $document.ready( function() {
window.wpResponsive = {
/**
* @summary Initializes the wpResponsive object.
* Initializes the wpResponsive object.
*
* @since 3.8.0
*
@ -1321,7 +1319,7 @@ $document.ready( function() {
},
/**
* @summary Changes properties of body and admin menu.
* Changes properties of body and admin menu.
*
* Pins and unpins the menu and adds the auto-fold class to the body.
* Makes the admin menu responsive and disables the metabox sortables.
@ -1342,7 +1340,7 @@ $document.ready( function() {
},
/**
* @summary Changes properties of admin menu and enables metabox sortables.
* Changes properties of admin menu and enables metabox sortables.
*
* Pin and unpin the menu.
* Removes the responsiveness of the admin menu and enables the metabox sortables.
@ -1358,7 +1356,7 @@ $document.ready( function() {
},
/**
* @summary Sets the responsiveness and enables the overlay based on the viewport width.
* Sets the responsiveness and enables the overlay based on the viewport width.
*
* @since 3.8.0
*
@ -1392,7 +1390,7 @@ $document.ready( function() {
},
/**
* @summary Inserts a responsive overlay and toggles the window.
* Inserts a responsive overlay and toggles the window.
*
* @since 3.8.0
*
@ -1415,7 +1413,7 @@ $document.ready( function() {
},
/**
* @summary Disables the responsive overlay and removes the overlay.
* Disables the responsive overlay and removes the overlay.
*
* @since 3.8.0
*
@ -1427,7 +1425,7 @@ $document.ready( function() {
},
/**
* @summary Disables sortables.
* Disables sortables.
*
* @since 3.8.0
*
@ -1442,7 +1440,7 @@ $document.ready( function() {
},
/**
* @summary Enables sortables.
* Enables sortables.
*
* @since 3.8.0
*
@ -1458,7 +1456,7 @@ $document.ready( function() {
};
/**
* @summary Add an ARIA role `button` to elements that behave like UI controls when JavaScript is on.
* Add an ARIA role `button` to elements that behave like UI controls when JavaScript is on.
*
* @since 4.5.0
*
@ -1473,7 +1471,7 @@ $document.ready( function() {
});
/**
* @summary Get the viewport width.
* Get the viewport width.
*
* @since 4.7.0
*
@ -1492,7 +1490,7 @@ $document.ready( function() {
}
/**
* @summary Sets the admin menu collapsed/expanded state.
* Sets the admin menu collapsed/expanded state.
*
* Sets the global variable `menuState` and triggers a custom event passing
* the current menu state.
@ -1519,7 +1517,7 @@ $document.ready( function() {
$document.on( 'wp-window-resized.set-menu-state', setMenuState );
/**
* @summary Sets ARIA attributes on the collapse/expand menu button.
* Sets ARIA attributes on the collapse/expand menu button.
*
* When the admin menu is open or folded, updates the `aria-expanded` and
* `aria-label` attributes of the button to give feedback to assistive
@ -1582,7 +1580,7 @@ $document.ready( function() {
var timeout;
/**
* @summary Triggers the WP window-resize event.
* Triggers the WP window-resize event.
*
* @since 3.8.0
*
@ -1593,7 +1591,7 @@ $document.ready( function() {
}
/**
* @summary Fires the trigger event again after 200 ms.
* Fires the trigger event again after 200 ms.
*
* @since 3.8.0
*

16
wp-admin/js/custom-background.js
View File

@ -1,7 +1,7 @@
/* global ajaxurl */
/**
* @summary Registers all events for customizing the background.
* Registers all events for customizing the background.
*
* @since 3.0.0
*
@ -13,7 +13,7 @@
bgImage = $( '#custom-background-image' );
/**
* @summary Instantiates the WordPress color picker and binds the change and clear events.
* Instantiates the WordPress color picker and binds the change and clear events.
*
* @since 3.5.0
*
@ -29,7 +29,7 @@
});
/**
* @summary Alters the background size CSS property whenever the background size input has changed.
* Alters the background size CSS property whenever the background size input has changed.
*
* @since 4.7.0
*
@ -40,7 +40,7 @@
});
/**
* @summary Alters the background position CSS property whenever the background position input has changed.
* Alters the background position CSS property whenever the background position input has changed.
*
* @since 4.7.0
*
@ -51,7 +51,7 @@
});
/**
* @summary Alters the background repeat CSS property whenever the background repeat input has changed.
* Alters the background repeat CSS property whenever the background repeat input has changed.
*
* @since 3.0.0
*
@ -62,7 +62,7 @@
});
/**
* @summary Alters the background attachment CSS property whenever the background attachment input has changed.
* Alters the background attachment CSS property whenever the background attachment input has changed.
*
* @since 4.7.0
*
@ -73,7 +73,7 @@
});
/**
* @summary Binds the event for opening the WP Media dialog.
* Binds the event for opening the WP Media dialog.
*
* @since 3.5.0
*
@ -113,7 +113,7 @@
});
/**
* @summary When an image is selected, run a callback.
* When an image is selected, run a callback.
*
* @since 3.5.0
*

7
wp-admin/js/custom-header.js
View File

@ -1,7 +1,7 @@
/* global isRtl */
/**
* @summary Initializes the custom header selection page.
* Initializes the custom header selection page.
*
* @since 3.5.0
*
@ -27,8 +27,7 @@
});
/**
* @summary Opens the 'choose from library' frame and creates it if it doesn't
* exist.
* Opens the 'choose from library' frame and creates it if it doesn't exist.
*
* @since 3.5.0
* @deprecated 4.1.0
@ -66,7 +65,7 @@
});
/**
* @summary Updates the window location to include the selected attachment.
* Updates the window location to include the selected attachment.
*
* @since 3.5.0
* @deprecated 4.1.0

92
wp-admin/js/editor-expand.js
View File

@ -7,7 +7,7 @@
$footer = $( '#wpfooter' );
/**
* @summary Handles the resizing of the editor.
* Handles the resizing of the editor.
*
* @since 4.0.0
*
@ -60,10 +60,9 @@
};
/**
* @summary Resizes textarea based on scroll height and width.
* Resizes textarea based on scroll height and width.
*
* Resizes textarea based on scroll height and width. Doesn't shrink the
* editor size below the 300px auto resize minimum height.
* Doesn't shrink the editor size below the 300px auto resize minimum height.
*
* @since 4.6.1
*
@ -90,7 +89,7 @@
}, 300 );
/**
* @summary Resizes the text editor depending on the old text length.
* Resizes the text editor depending on the old text length.
*
* If there is an mceEditor and it is hidden, it resizes the editor depending
* on the old text length. If the current length of the text is smaller than
@ -123,7 +122,7 @@
}
/**
* @summary Gets the height and widths of elements.
* Gets the height and widths of elements.
*
* Gets the heights of the window, the adminbar, the tools, the menu,
* the visualTop, the textTop, the bottom, the statusbar and sideSortables
@ -158,8 +157,8 @@
// We need to wait for TinyMCE to initialize.
/**
* @summary Binds all necessary functions for editor expand to the editor
* when the editor is initialized.
* Binds all necessary functions for editor expand to the editor when the editor
* is initialized.
*
* @since 4.0.0
*
@ -172,7 +171,7 @@
// VK contains the type of key pressed. VK = virtual keyboard.
var VK = window.tinymce.util.VK,
/**
* @summary Hides any float panel with a hover state. Additionally hides tooltips.
* Hides any float panel with a hover state. Additionally hides tooltips.
*
* @returns {void}
*/
@ -199,7 +198,7 @@
$menuBar = $contentWrap.find( '.mce-menubar' );
/**
* @summary Gets the offset of the editor.
* Gets the offset of the editor.
*
* @returns {Number|Boolean} Returns the offset of the editor
* or false if there is no offset height.
@ -232,7 +231,7 @@
}
/**
* @summary Filters the special keys that should not be used for scrolling.
* Filters the special keys that should not be used for scrolling.
*
* @since 4.0.0
*
@ -255,7 +254,7 @@
}
/**
* @summary Makes sure the cursor is always visible in the editor.
* Makes sure the cursor is always visible in the editor.
*
* Makes sure the cursor is kept between the toolbars of the editor and scrolls
* the window when the cursor moves out of the viewport to a wpview.
@ -322,7 +321,7 @@
}
/**
* @summary If the editor is fullscreen, calls adjust.
* If the editor is fullscreen, calls adjust.
*
* @since 4.1.0
*
@ -338,7 +337,7 @@
}
/**
* @summary Shows the editor when scrolled.
* Shows the editor when scrolled.
*
* Binds the hideFloatPanels function on the window scroll.mce-float-panels event.
* Executes the wpAutoResize on the active editor.
@ -357,7 +356,7 @@
}
/**
* @summary Resizes the editor.
* Resizes the editor.
*
* Removes all functions from the window scroll.mce-float-panels event.
* Resizes the text editor and scrolls to a position based on the pageXOffset and adminBarHeight.
@ -384,7 +383,7 @@
}
/**
* @summary Toggles advanced states.
* Toggles advanced states.
*
* @since 4.1.0
*
@ -395,7 +394,7 @@
}
/**
* @summary Binds events of the editor and window.
* Binds events of the editor and window.
*
* @since 4.0.0
*
@ -420,7 +419,7 @@
};
/**
* @summary Unbinds the events of the editor and window.
* Unbinds the events of the editor and window.
*
* @since 4.0.0
*
@ -447,10 +446,11 @@
} );
/**
* @summary Adjusts the toolbars heights and positions.
* Adjusts the toolbars heights and positions.
*
* Adjusts the toolbar heights and positions based on the scroll position on the page,
* the active editor mode and the heights of the editor, admin bar and side bar.
* Adjusts the toolbars heights and positions based on the scroll position on
* the page, the active editor mode and the heights of the editor, admin bar and
* side bar.
*
* @since 4.0.0
*
@ -764,7 +764,7 @@
}
/**
* @summary Resizes the editor and adjusts the toolbars.
* Resizes the editor and adjusts the toolbars.
*
* @since 4.0.0
*
@ -776,7 +776,7 @@
}
/**
* @summary Runs the passed function with 500ms intervals.
* Runs the passed function with 500ms intervals.
*
* @since 4.0.0
*
@ -791,7 +791,7 @@
}
/**
* @summary Runs adjust after 100ms.
* Runs adjust after 100ms.
*
* @since 4.0.0
*
@ -803,7 +803,7 @@
}
/**
* @summary Binds editor expand events on elements.
* Binds editor expand events on elements.
*
* @since 4.0.0
*
@ -873,7 +873,7 @@
}
/**
* @summary Unbinds editor expand events.
* Unbinds editor expand events.
*
* @since 4.0.0
*
@ -967,7 +967,7 @@
} );
/**
* @summary Handles the distraction free writing of TinyMCE.
* Handles the distraction free writing of TinyMCE.
*
* @since 4.1.0
*
@ -1017,7 +1017,7 @@
} );
/**
* @summary Recalculates the bottom and right position of the editor in the DOM.
* Recalculates the bottom and right position of the editor in the DOM.
*
* @since 4.1.0
*
@ -1030,7 +1030,7 @@
}
/**
* @summary Activates the distraction free writing mode.
* Activates the distraction free writing mode.
*
* @since 4.1.0
*
@ -1046,7 +1046,7 @@
}
/**
* @summary Deactivates the distraction free writing mode.
* Deactivates the distraction free writing mode.
*
* @since 4.1.0
*
@ -1064,7 +1064,7 @@
}
/**
* @summary Returns _isActive.
* Returns _isActive.
*
* @since 4.1.0
*
@ -1075,7 +1075,7 @@
}
/**
* @summary Binds events on the editor for distraction free writing.
* Binds events on the editor for distraction free writing.
*
* @since 4.1.0
*
@ -1098,7 +1098,7 @@
}
/**
* @summary Unbinds events on the editor for distraction free writing.
* Unbinds events on the editor for distraction free writing.
*
* @since 4.1.0
*
@ -1121,7 +1121,7 @@
}
/**
* @summary Binds or unbinds the editor expand events.
* Binds or unbinds the editor expand events.
*
* @since 4.1.0
*
@ -1136,7 +1136,7 @@
}
/**
* @summary Returns the value of _isOn.
* Returns the value of _isOn.
*
* @since 4.1.0
*
@ -1147,7 +1147,7 @@
}
/**
* @summary Fades out all elements except for the editor.
* Fades out all elements except for the editor.
*
* The fading is done based on key presses and mouse movements.
* Also calls the fadeIn on certain key presses
@ -1290,7 +1290,7 @@
}
/**
* @summary Fades all elements back in.
* Fades all elements back in.
*
* @since 4.1.0
*
@ -1338,7 +1338,7 @@
}
/**
* @summary Fades in if the focused element based on it position.
* Fades in if the focused element based on it position.
*
* @since 4.1.0
*
@ -1360,7 +1360,7 @@
}
/**
* @summary Fades out the admin bar based on focus on the admin bar.
* Fades out the admin bar based on focus on the admin bar.
*
* @since 4.1.0
*
@ -1381,7 +1381,7 @@
}
/**
* @summary Fades in the admin bar.
* Fades in the admin bar.
*
* @since 4.1.0
*
@ -1396,7 +1396,7 @@
}
/**
* @summary Fades out the edit slug box.
* Fades out the edit slug box.
*
* @since 4.1.0
*
@ -1413,7 +1413,7 @@
}
/**
* @summary Fades in the edit slug box.
* Fades in the edit slug box.
*
* @since 4.1.0
*
@ -1430,7 +1430,7 @@
}
/**
* @summary Triggers the toggle on Alt + Shift + W.
* Triggers the toggle on Alt + Shift + W.
*
* Keycode 87 = w.
*
@ -1451,7 +1451,7 @@
}
/**
* @summary Adds the distraction free writing button when setting up TinyMCE.
* Adds the distraction free writing button when setting up TinyMCE.
*
* @since 4.1.0
*
@ -1492,7 +1492,7 @@
} );
/**
* @summary Binds and unbinds events on the editor.
* Binds and unbinds events on the editor.
*
* @since 4.1.0
*
@ -1549,7 +1549,7 @@
} );
/**
* @summary Binds events on quicktags init.
* Binds events on quicktags init.
*
* @since 4.1.0
*

38
wp-admin/js/editor.js
View File

@ -4,7 +4,7 @@ window.wp = window.wp || {};
wp.editor = wp.editor || {};
/**
* @summary Utility functions for the editor.
* Utility functions for the editor.
*
* @since 2.5.0
*/
@ -18,7 +18,7 @@ window.wp = window.wp || {};
$$ = tinymce.$;
/**
* @summary Handles onclick events for the Visual/Text tabs.
* Handles onclick events for the Visual/Text tabs.
*
* @since 4.3.0
*
@ -38,7 +38,7 @@ window.wp = window.wp || {};
}
/**
* @summary Returns the height of the editor toolbar(s) in px.
* Returns the height of the editor toolbar(s) in px.
*
* @since 3.9.0
*
@ -58,7 +58,7 @@ window.wp = window.wp || {};
}
/**
* @summary Switches the editor between Visual and Text mode.
* Switches the editor between Visual and Text mode.
*
* @since 2.5.0
*
@ -184,7 +184,7 @@ window.wp = window.wp || {};
}
/**
* @summary Checks if a cursor is inside an HTML tag.
* Checks if a cursor is inside an HTML tag.
*
* In order to prevent breaking HTML tags when selecting text, the cursor
* must be moved to either the start or end of the tag.
@ -227,7 +227,7 @@ window.wp = window.wp || {};
}
/**
* @summary Check if the cursor is inside a shortcode
* Checks if the cursor is inside a shortcode
*
* If the cursor is inside a shortcode wrapping tag, e.g. `[caption]` it's better to
* move the selection marker to before or after the shortcode.
@ -281,7 +281,7 @@ window.wp = window.wp || {};
}
/**
* @summary Check if a shortcode has Live Preview enabled for it.
* Checks if a shortcode has Live Preview enabled for it.
*
* Previewable shortcodes here refers to shortcodes that have Live Preview enabled.
*
@ -305,7 +305,7 @@ window.wp = window.wp || {};
}
/**
* @summary Get all shortcodes and their positions in the content
* Gets all shortcodes and their positions in the content
*
* This function returns all the shortcodes that could be found in the textarea content
* along with their character positions and boundaries.
@ -414,7 +414,7 @@ window.wp = window.wp || {};
}
/**
* @summary Get adjusted selection cursor positions according to HTML tags/shortcodes
* Gets adjusted selection cursor positions according to HTML tags/shortcodes
*
* Shortcodes and HTML codes are a bit of a special case when selecting, since they may render
* content in Visual mode. If we insert selection markers somewhere inside them, it's really possible
@ -497,7 +497,7 @@ window.wp = window.wp || {};
}
/**
* @summary Adds text selection markers in the editor textarea.
* Adds text selection markers in the editor textarea.
*
* Adds selection markers in the content of the editor `textarea`.
* The method directly manipulates the `textarea` content, to allow TinyMCE plugins
@ -547,7 +547,7 @@ window.wp = window.wp || {};
}
/**
* @summary Focus the selection markers in Visual mode.
* Focuses the selection markers in Visual mode.
*
* The method checks for existing selection markers inside the editor DOM (Visual mode)
* and create a selection between the two nodes using the DOM `createRange` selection API
@ -586,7 +586,7 @@ window.wp = window.wp || {};
}
/**
* @summary Remove selection marker and the parent node if it is an empty paragraph.
* Removes selection marker and the parent node if it is an empty paragraph.
*
* By default TinyMCE wraps loose inline tags in a `<p>`.
* When removing selection markers an empty `<p>` may be left behind, remove it.
@ -605,7 +605,7 @@ window.wp = window.wp || {};
}
/**
* @summary Scrolls the content to place the selected element in the center of the screen.
* Scrolls the content to place the selected element in the center of the screen.
*
* Takes an element, that is usually the selection start element, selected in
* `focusHTMLBookmarkInVisualEditor()` and scrolls the screen so the element appears roughly
@ -680,7 +680,7 @@ window.wp = window.wp || {};
}
/**
* @summary Finds the current selection position in the Visual editor.
* Finds the current selection position in the Visual editor.
*
* Find the current selection in the Visual editor by inserting marker elements at the start
* and end of the selection.
@ -847,7 +847,7 @@ window.wp = window.wp || {};
}
/**
* @summary Selects text in the TinyMCE `textarea`.
* Selects text in the TinyMCE `textarea`.
*
* Selects the text in TinyMCE's textarea that's between `selection.start` and `selection.end`.
*
@ -888,7 +888,7 @@ window.wp = window.wp || {};
} );
/**
* @summary Replaces <p> tags with two line breaks. "Opposite" of wpautop().
* Replaces <p> tags with two line breaks. "Opposite" of wpautop().
*
* Replaces <p> tags with two line breaks except where the <p> has attributes.
* Unifies whitespace.
@ -1027,7 +1027,7 @@ window.wp = window.wp || {};
}
/**
* @summary Replaces two line breaks with a paragraph tag and one line break with a <br>.
* Replaces two line breaks with a paragraph tag and one line break with a <br>.
*
* Similar to `wpautop()` in formatting.php.
*
@ -1156,7 +1156,7 @@ window.wp = window.wp || {};
}
/**
* @summary Fires custom jQuery events `beforePreWpautop` and `afterPreWpautop` when jQuery is available.
* Fires custom jQuery events `beforePreWpautop` and `afterPreWpautop` when jQuery is available.
*
* @since 2.9.0
*
@ -1182,7 +1182,7 @@ window.wp = window.wp || {};
}
/**
* @summary Fires custom jQuery events `beforeWpautop` and `afterWpautop` when jQuery is available.
* Fires custom jQuery events `beforeWpautop` and `afterWpautop` when jQuery is available.
*
* @since 2.9.0
*

63
wp-admin/js/image-edit.js
View File

@ -1,8 +1,8 @@
/* global imageEditL10n, ajaxurl, confirm */
/**
* @summary The functions necessary for editing images.
* The functions necessary for editing images.
*
* @since 2.9.0
* @since 2.9.0
*/
(function($) {
@ -44,7 +44,7 @@
},
/**
* @summary Converts a value to an integer.
* Converts a value to an integer.
*
* @memberof imageEdit
* @since 2.9.0
@ -62,8 +62,7 @@
},
/**
* @summary Adds the disabled attribute and class to a single form element
* or a field set.
* Adds the disabled attribute and class to a single form element or a field set.
*
* @memberof imageEdit
* @since 2.9.0
@ -92,7 +91,7 @@
},
/**
* @summary Initializes the image editor.
* Initializes the image editor.
*
* @memberof imageEdit
* @since 2.9.0
@ -135,7 +134,7 @@
},
/**
* @summary Toggles the wait/load icon in the editor.
* Toggles the wait/load icon in the editor.
*
* @memberof imageEdit
* @since 2.9.0
@ -156,7 +155,7 @@
},
/**
* @summary Shows or hides the image edit help box.
* Shows or hides the image edit help box.
*
* @memberof imageEdit
* @since 2.9.0
@ -175,7 +174,7 @@
},
/**
* @summary Gets the value from the image edit target.
* Gets the value from the image edit target.
*
* The image edit target contains the image sizes where the (possible) changes
* have to be applied to.
@ -193,7 +192,7 @@
},
/**
* @summary Recalculates the height or width and keeps the original aspect ratio.
* Recalculates the height or width and keeps the original aspect ratio.
*
* If the original image size is exceeded a red exclamation mark is shown.
*
@ -231,7 +230,7 @@
},
/**
* @summary Gets the selected aspect ratio.
* Gets the selected aspect ratio.
*
* @memberof imageEdit
* @since 2.9.0
@ -257,7 +256,7 @@
},
/**
* @summary Removes the last action from the image edit history
* Removes the last action from the image edit history.
* The history consist of (edit) actions performed on the image.
*
* @memberof imageEdit
@ -321,7 +320,7 @@
return '';
},
/**
* @summary Binds the necessary events to the image.
* Binds the necessary events to the image.
*
* When the image source is reloaded the image will be reloaded.
*
@ -396,7 +395,7 @@
.attr('src', ajaxurl + '?' + $.param(data));
},
/**
* @summary Performs an image edit action.
* Performs an image edit action.
*
* @memberof imageEdit
* @since 2.9.0
@ -463,7 +462,7 @@
},
/**
* @summary Stores the changes that are made to the image.
* Stores the changes that are made to the image.
*
* @memberof imageEdit
* @since 2.9.0
@ -528,7 +527,7 @@
},
/**
* @summary Creates the image edit window.
* Creates the image edit window.
*
* @memberof imageEdit
* @since 2.9.0
@ -585,7 +584,7 @@
},
/**
* @summary Initializes the cropping tool and sets a default cropping selection.
* Initializes the cropping tool and sets a default cropping selection.
*
* @memberof imageEdit
* @since 2.9.0
@ -611,7 +610,7 @@
},
/**
* @summary Initializes the cropping tool.
* Initializes the cropping tool.
*
* @memberof imageEdit
* @since 2.9.0
@ -637,7 +636,7 @@
minHeight: 3,
/**
* @summary Sets the CSS styles and binds events for locking the aspect ratio.
* Sets the CSS styles and binds events for locking the aspect ratio.
*
* @ignore
*
@ -650,7 +649,7 @@
$img.next().css( 'position', 'absolute' )
.nextAll( '.imgareaselect-outer' ).css( 'position', 'absolute' );
/**
* @summary Binds mouse down event to the cropping container.
* Binds mouse down event to the cropping container.
*
* @returns {void}
*/
@ -670,7 +669,7 @@
},
/**
* @summary Event triggered when starting a selection.
* Event triggered when starting a selection.
*
* @ignore
*
@ -680,7 +679,7 @@
imageEdit.setDisabled($('#imgedit-crop-sel-' + postid), 1);
},
/**
* @summary Event triggered when the selection is ended.
* Event triggered when the selection is ended.
*
* @ignore
*
@ -694,7 +693,7 @@
},
/**
* @summary Event triggered when the selection changes.
* Event triggered when the selection changes.
*
* @ignore
*
@ -712,7 +711,7 @@
},
/**
* @summary Stores the current crop selection.
* Stores the current crop selection.
*
* @memberof imageEdit
* @since 2.9.0
@ -743,7 +742,7 @@
/**
* @summary Closes the image editor.
* Closes the image editor.
*
* @memberof imageEdit
* @since 2.9.0
@ -784,7 +783,7 @@
},
/**
* @summary Checks if the image edit history is saved.
* Checks if the image edit history is saved.
*
* @memberof imageEdit
* @since 2.9.0
@ -808,7 +807,7 @@
},
/**
* @summary Adds an image edit action to the history.
* Adds an image edit action to the history.
*
* @memberof imageEdit
* @since 2.9.0
@ -841,7 +840,7 @@
},
/**
* @summary Rotates the image.
* Rotates the image.
*
* @memberof imageEdit
* @since 2.9.0
@ -862,7 +861,7 @@
},
/**
* @summary Flips the image.
* Flips the image.
*
* @memberof imageEdit
* @since 2.9.0
@ -883,7 +882,7 @@
},
/**
* @summary Crops the image.
* Crops the image.
*
* @memberof imageEdit
* @since 2.9.0
@ -912,7 +911,7 @@
},
/**
* @summary Undoes an image edit action.
* Undoes an image edit action.
*
* @memberof imageEdit
* @since 2.9.0
@ -975,7 +974,7 @@
},
/**
* @summary Sets the selection for the height and width in pixels.
* Sets the selection for the height and width in pixels.
*
* @memberof imageEdit
* @since 2.9.0

51
wp-admin/js/inline-edit-post.js
View File

@ -26,7 +26,7 @@ var inlineEditPost;
inlineEditPost = {
/**
* @summary Initializes the inline and bulk post editor.
* Initializes the inline and bulk post editor.
*
* Binds event handlers to the escape key to close the inline editor
* and to the save and close buttons. Changes DOM to be ready for inline
@ -45,7 +45,7 @@ var inlineEditPost;
t.what = '#post-';
/**
* @summary Bind escape key to revert the changes and close the quick editor.
* Binds the escape key to revert the changes and close the quick editor.
*
* @returns {boolean} The result of revert.
*/
@ -57,7 +57,7 @@ var inlineEditPost;
});
/**
* @summary Bind escape key to revert the changes and close the bulk editor.
* Binds the escape key to revert the changes and close the bulk editor.
*
* @returns {boolean} The result of revert.
*/
@ -69,7 +69,7 @@ var inlineEditPost;
});
/**
* @summary Revert changes and close the quick editor if the cancel button is clicked.
* Reverts changes and close the quick editor if the cancel button is clicked.
*
* @returns {boolean} The result of revert.
*/
@ -78,7 +78,7 @@ var inlineEditPost;
});
/**
* @summary Save changes in the quick editor if the save(named: update) button is clicked.
* Saves changes in the quick editor if the save(named: update) button is clicked.
*
* @returns {boolean} The result of save.
*/
@ -87,7 +87,7 @@ var inlineEditPost;
});
/**
* @summary If enter is pressed, and the target is not the cancel button, save the post.
* If enter is pressed, and the target is not the cancel button, save the post.
*
* @returns {boolean} The result of save.
*/
@ -98,7 +98,7 @@ var inlineEditPost;
});
/**
* @summary Revert changes and close the bulk editor if the cancel button is clicked.
* Reverts changes and close the bulk editor if the cancel button is clicked.
*
* @returns {boolean} The result of revert.
*/
@ -107,7 +107,7 @@ var inlineEditPost;
});
/**
* @summary Disables the password input field when the private post checkbox is checked.
* Disables the password input field when the private post checkbox is checked.
*/
$('#inline-edit .inline-edit-private input[value="private"]').click( function(){
var pw = $('input.inline-edit-password-input');
@ -119,7 +119,7 @@ var inlineEditPost;
});
/**
* @summary Bind click event to the .editinline link which opens the quick editor.
* Binds click event to the .editinline link which opens the quick editor.
*/
$('#the-list').on( 'click', 'a.editinline', function( e ) {
e.preventDefault();
@ -135,7 +135,7 @@ var inlineEditPost;
$('select[name="_status"] option[value="future"]', bulkRow).remove();
/**
* @summary Adds onclick events to the apply buttons.
* Adds onclick events to the apply buttons.
*/
$('#doaction, #doaction2').click(function(e){
var n;
@ -153,9 +153,8 @@ var inlineEditPost;
},
/**
* @summary Toggles the quick edit window.
*
* Hides the window when it's active and shows the window when inactive.
* Toggles the quick edit window, hiding it when it's active and showing it when
* inactive.
*
* @memberof inlineEditPost
* @since 2.7.0
@ -168,7 +167,7 @@ var inlineEditPost;
},
/**
* @summary Creates the bulk editor row to edit multiple posts at once.
* Creates the bulk editor row to edit multiple posts at once.
*
* @memberof inlineEditPost
* @since 2.7.0
@ -184,10 +183,10 @@ var inlineEditPost;
$('#bulk-edit').addClass('inline-editor').show();
/**
* @summary Create a HTML div with the title and a delete link(cross-icon) for each selected post.
* Create a HTML div with the title and a link(delete-icon) for each selected
* post.
*
* Get the selected posts based on the checked checkboxes in the post table.
* Create a HTML div with the title and a link(delete-icon) for each selected post.
*/
$( 'tbody th.check-column input[type="checkbox"]' ).each( function() {
@ -208,7 +207,7 @@ var inlineEditPost;
// Add onclick events to the delete-icons in the bulk editors the post title list.
$('#bulk-titles').html(te);
/**
* @summary Binds on click events to the checkboxes before the posts in the table.
* Binds on click events to the checkboxes before the posts in the table.
*
* @listens click
*/
@ -240,7 +239,7 @@ var inlineEditPost;
},
/**
* @summary Creates a quick edit window for the post that has been clicked.
* Creates a quick edit window for the post that has been clicked.
*
* @memberof inlineEditPost
* @since 2.7.0
@ -283,7 +282,7 @@ var inlineEditPost;
val = $('.'+fields[f], rowData);
/**
* @summary Replaces the image for a Twemoji(Twitter emoji) with it's alternate text.
* Replaces the image for a Twemoji(Twitter emoji) with it's alternate text.
*
* @returns Alternate text from the image.
*/
@ -303,7 +302,7 @@ var inlineEditPost;
}
/**
* @summary Creates the select boxes for the categories.
* Creates the select boxes for the categories.
*/
$('.post_category', rowData).each(function(){
var taxname,
@ -316,8 +315,8 @@ var inlineEditPost;
});
/**
* @summary Gets all the taxonomies for live auto-fill suggestions.
* When typing the name of a tag.
* Gets all the taxonomies for live auto-fill suggestions when typing the name
* of a tag.
*/
$('.tags_input', rowData).each(function(){
var terms = $(this),
@ -380,7 +379,7 @@ var inlineEditPost;
},
/**
* @summary Saves the changes made in the quick edit window to the post.
* Saves the changes made in the quick edit window to the post.
* AJAX saving is only for Quick Edit and not for bulk edit.
*
* @since 2.7.0
@ -446,7 +445,7 @@ var inlineEditPost;
},
/**
* @summary Hides and empties the Quick Edit and/or Bulk Edit windows.
* Hides and empties the Quick Edit and/or Bulk Edit windows.
*
* @memberof inlineEditPost
* @since 2.7.0
@ -487,8 +486,8 @@ var inlineEditPost;
},
/**
* @summary Gets the id for a the post that you want to quick edit from the row
* in the quick edit table.
* Gets the id for a the post that you want to quick edit from the row in the quick
* edit table.
*
* @memberof inlineEditPost
* @since 2.7.0

21
wp-admin/js/inline-edit-tax.js
View File

@ -21,9 +21,8 @@ var inlineEditTax;
inlineEditTax = {
/**
* @summary Initializes the inline taxonomy editor.
*
* Adds event handlers to be able to quick edit.
* Initializes the inline taxonomy editor by adding event handlers to be able to
* quick edit.
*
* @since 2.7.0
*
@ -42,8 +41,8 @@ inlineEditTax = {
return false;
});
/*
* @summary Cancels inline editing when pressing escape inside the inline editor.
/**
* Cancels inline editing when pressing escape inside the inline editor.
*
* @param {Object} e The keyup event that has been triggered.
*/
@ -55,21 +54,21 @@ inlineEditTax = {
});
/**
* @summary Cancels inline editing when clicking the cancel button.
* Cancels inline editing when clicking the cancel button.
*/
$( '.cancel', row ).click( function() {
return inlineEditTax.revert();
});
/**
* @summary Saves the inline edits when clicking the save button.
* Saves the inline edits when clicking the save button.
*/
$( '.save', row ).click( function() {
return inlineEditTax.save(this);
});
/**
* @summary Saves the inline edits when pressing enter inside the inline editor.
* Saves the inline edits when pressing enter inside the inline editor.
*/
$( 'input, select', row ).keydown( function( e ) {
// 13 = [enter]
@ -79,7 +78,7 @@ inlineEditTax = {
});
/**
* @summary Saves the inline edits on submitting the inline edit form.
* Saves the inline edits on submitting the inline edit form.
*/
$( '#posts-filter input[type="submit"]' ).mousedown( function() {
t.revert();
@ -149,7 +148,7 @@ inlineEditTax = {
},
/**
* @summary Saves the quick edit data.
* Saves the quick edit data.
*
* Saves the quick edit data to the server and replaces the table row with the
* HTML retrieved from the server.
@ -187,7 +186,7 @@ inlineEditTax = {
// Do the ajax request to save the data to the server.
$.post( ajaxurl, params,
/**
* @summary Handles the response from the server.
* Handles the response from the server
*
* Handles the response from the server, replaces the table row with the response
* from the server.

26
wp-admin/js/media.js
View File

@ -1,7 +1,8 @@
/* global ajaxurl, attachMediaBoxL10n, _wpMediaGridSettings, showNotice */
/**
* @summary Creates a dialog containing posts that can have a particular media attached to it.
* Creates a dialog containing posts that can have a particular media attached
* to it.
*
* @since 2.7.0
*
@ -14,7 +15,7 @@ var findPosts;
( function( $ ){
findPosts = {
/**
* @summary Opens a dialog to attach media to a post.
* Opens a dialog to attach media to a post.
*
* Adds an overlay prior to retrieving a list of posts to attach the media to.
*
@ -58,7 +59,7 @@ var findPosts;
},
/**
* @summary Clears the found posts lists before hiding the attach media dialog.
* Clears the found posts lists before hiding the attach media dialog.
*
* @since 2.7.0
*
@ -73,7 +74,8 @@ var findPosts;
},
/**
* @summary Binds a click event listener to the overlay which closes the attach media dialog.
* Binds a click event listener to the overlay which closes the attach media
* dialog.
*
* @since 3.5.0
*
@ -88,10 +90,11 @@ var findPosts;
},
/**
* @summary Retrieves and displays posts based on the search term.
* Retrieves and displays posts based on the search term.
*
* Sends a post request to the admin_ajax.php, requesting posts based on the search term provided by the user.
* Defaults to all posts if no search term is provided.
* Sends a post request to the admin_ajax.php, requesting posts based on the
* search term provided by the user. Defaults to all posts if no search term is
* provided.
*
* @since 2.7.0
*
@ -110,8 +113,8 @@ var findPosts;
spinner.addClass( 'is-active' );
/**
* Send a POST request to admin_ajax.php, hide the spinner and replace the list of posts with the response data.
* If an error occurs, display it.
* Send a POST request to admin_ajax.php, hide the spinner and replace the list
* of posts with the response data. If an error occurs, display it.
*/
$.ajax( ajaxurl, {
type: 'POST',
@ -132,7 +135,8 @@ var findPosts;
};
/**
* @summary Initializes the file once the DOM is fully loaded and attaches events to the various form elements.
* Initializes the file once the DOM is fully loaded and attaches events to the
* various form elements.
*
* @returns {void}
*/
@ -192,7 +196,7 @@ var findPosts;
});
/**
* @summary Enables clicking on the entire table row.
* Enables clicking on the entire table row.
*
* @returns {void}
*/

13
wp-admin/js/post.js
View File

@ -2,9 +2,7 @@
/* global theList:true, theExtraList:true, getUserSetting, setUserSetting, commentReply */
/**
* Contains all dynamic functionality needed on post and term pages.
*
* @file Control page and term functionality.
* @file Contains all dynamic functionality needed on post and term pages.
*/
var commentsBox, WPSetThumbnailHTML, WPSetThumbnailID, WPRemoveThumbnail, wptitlehint, makeSlugeditClickable, editPermalink;
@ -934,9 +932,8 @@ jQuery(document).ready( function($) {
}
/**
* Handle the editing of the post_name. Create the required HTML elements and update the changes via AJAX.
*
* @summary Permalink aka slug aka post_name editing
* Handle the editing of the post_name. Create the required HTML elements and
* update the changes via AJAX.
*
* @global
*
@ -1041,9 +1038,7 @@ jQuery(document).ready( function($) {
});
/**
* Add screen reader text to the title prompt when needed.
*
* @summary Title screen reader text handler.
* Adds screen reader text to the title prompt when needed.
*
* @param {string} id Optional. HTML ID to add the screen reader helper text to.
*

33
wp-admin/js/postbox.js
View File

@ -2,8 +2,6 @@
* Contains the postboxes logic, opening and closing postboxes, reordering and saving
* the state and ordering to the database.
*
* @summary Contains postboxes logic
*
* @since 2.5.0
* @requires jQuery
*/
@ -28,7 +26,7 @@ var postboxes;
postboxes = {
/**
* @summary Handles a click on either the postbox heading or the postbox open/close icon.
* Handles a click on either the postbox heading or the postbox open/close icon.
*
* Opens or closes the postbox. Expects `this` to equal the clicked element.
* Calls postboxes.pbshow if the postbox has been opened, calls postboxes.pbhide
@ -76,7 +74,7 @@ var postboxes;
}
/**
* @summary Fires when a postbox has been opened or closed.
* Fires when a postbox has been opened or closed.
*
* Contains a jQuery object with the relevant postbox element.
*
@ -117,7 +115,7 @@ var postboxes;
});
/**
* @summary Hides a postbox.
* Hides a postbox.
*
* Event handler for the postbox dismiss button. After clicking the button
* the postbox will be hidden.
@ -133,7 +131,7 @@ var postboxes;
});
/**
* @summary Hides the postbox element
* Hides the postbox element
*
* Event handler for the screen options checkboxes. When a checkbox is
* clicked this function will hide or show the relevant postboxes.
@ -173,7 +171,7 @@ var postboxes;
});
/**
* @summary Changes the amount of columns based on the layout preferences.
* Changes the amount of columns based on the layout preferences.
*
* @since 2.8.0
*
@ -190,7 +188,7 @@ var postboxes;
},
/**
* @summary Initializes all the postboxes, mainly their sortable behaviour.
* Initializes all the postboxes, mainly their sortable behaviour.
*
* @since 2.7.0
* @memberof postboxes
@ -269,10 +267,10 @@ var postboxes;
},
/**
* @summary Saves the state of the postboxes to the server.
* Saves the state of the postboxes to the server.
*
* Saves the state of the postboxes to the server. It sends two lists, one with
* all the closed postboxes, one with all the hidden postboxes.
* It sends two lists, one with all the closed postboxes, one with all the
* hidden postboxes.
*
* @since 2.7.0
* @memberof postboxes
@ -301,10 +299,9 @@ var postboxes;
},
/**
* @summary Saves the order of the postboxes to the server.
* Saves the order of the postboxes to the server.
*
* Saves the order of the postboxes to the server. Sends a list of all postboxes
* inside a sortable area to the server.
* Sends a list of all postboxes inside a sortable area to the server.
*
* @since 2.8.0
* @memberof postboxes
@ -330,7 +327,7 @@ var postboxes;
},
/**
* @summary Marks empty postbox areas.
* Marks empty postbox areas.
*
* Adds a message to empty sortable areas on the dashboard page. Also adds a
* border around the side area on the post edit screen if there are no postboxes
@ -366,7 +363,7 @@ var postboxes;
},
/**
* @summary Changes the amount of columns on the post edit page.
* Changes the amount of columns on the post edit page.
*
* @since 3.3.0
* @memberof postboxes
@ -395,8 +392,8 @@ var postboxes;
},
/**
* @summary Changes the amount of columns the postboxes are in based on the
* current orientation of the browser.
* Changes the amount of columns the postboxes are in based on the current
* orientation of the browser.
*
* @since 3.3.0
* @memberof postboxes

18
wp-admin/js/tags.js
View File

@ -1,18 +1,16 @@
/* global ajaxurl, wpAjax, tagsl10n, showNotice, validateForm */
/**
* Contains logic for both adding and deleting tags. For deleting tags it makes a request
* to the server to delete the tag. For adding tags it makes a request to the server to
* add the tag.
* Contains logic for deleting and adding tags.
*
* @summary Contains logic for deleting and adding tags
* For deleting tags it makes a request to the server to delete the tag.
* For adding tags it makes a request to the server to add the tag.
*/
jQuery(document).ready(function($) {
/**
* @summary Adds an event handler to the delete term link on the term overview page.
*
* Adds an event handler to the delete term link on the term overview page.
*
* Cancels default event handling and event bubbling.
*
* @since 2.8.0
@ -29,8 +27,8 @@ jQuery(document).ready(function($) {
data = t.attr('href').replace(/[^?]*\?/, '').replace(/action=delete/, 'action=delete-tag');
/**
* @summary Makes a request to the server to delete the term that
* corresponds to the delete term button.
* Makes a request to the server to delete the term that corresponds to the
* delete term button.
*
* @param {string} r The response from the server.
*
@ -42,7 +40,7 @@ jQuery(document).ready(function($) {
tr.fadeOut('normal', function(){ tr.remove(); });
/**
* @summary Remove the term from the parent box and the tag cloud
* Removes the term from the parent box and the tag cloud.
*
* `data.match(/tag_ID=(\d+)/)[1]` matches the term id from the data variable.
* This term id is then used to select the relevant HTML elements:
@ -87,7 +85,7 @@ jQuery(document).ready(function($) {
});
/**
* @summary Adds an event handler tot he form submit on the term overview page.
* Adds an event handler to the form submit on the term overview page.
*
* Cancels default event handling and event bubbling.
*

7
wp-admin/js/word-count.js
View File

@ -1,7 +1,6 @@
/**
* Word or character counting functionality. Count words or characters in a provided text string.
*
* @summary Count words or characters in a text.
* Word or character counting functionality. Count words or characters in a
* provided text string.
*
* @namespace wp.utils
* @since 2.6.0
@ -143,8 +142,6 @@
/**
* Counts the number of words (or other specified type) in the specified text.
*
* @summary Count the number of elements in a text.
*
* @since 2.6.0
* @memberof wp.utils.wordcounter
*

3
wp-content/themes/twentyfifteen/js/functions.js
View File

@ -77,7 +77,8 @@
} )();
/**
* @summary Add or remove ARIA attributes.
* Add or remove ARIA attributes.
*
* Uses jQuery's width() function to determine the size of the window and add
* the default ARIA attributes for the menu toggle if it's visible.
* @since Twenty Fifteen 1.1

3
wp-content/themes/twentyfourteen/js/functions.js
View File

@ -122,7 +122,8 @@
} );
/**
* @summary Add or remove ARIA attributes.
* Add or remove ARIA attributes.
*
* Uses jQuery's width() function to determine the size of the window and add
* the default ARIA attributes for the menu toggle if it's visible.
* @since Twenty Fourteen 1.4

4
wp-content/themes/twentythirteen/js/functions.js
View File

@ -75,9 +75,11 @@
} )();
/**
* @summary Add or remove ARIA attributes.
* Add or remove ARIA attributes.
*
* Uses jQuery's width() function to determine the size of the window and add
* the default ARIA attributes for the menu toggle if it's visible.
*
* @since Twenty Thirteen 1.5
*/
function onResizeARIA() {

80
wp-includes/js/autosave.js
View File

@ -5,7 +5,7 @@ window.autosave = function() {
};
/**
* @summary Adds autosave to the window object on dom ready.
* Adds autosave to the window object on dom ready.
*
* @since 3.9.0
*
@ -15,7 +15,7 @@ window.autosave = function() {
*/
( function( $, window ) {
/**
* @summary Auto saves the post.
* Auto saves the post.
*
* @since 3.9.0
*
@ -36,7 +36,7 @@ window.autosave = function() {
$document = $(document);
/**
* @summary Returns the data saved in both local and remote autosave.
* Returns the data saved in both local and remote autosave.
*
* @since 3.9.0
*
@ -99,9 +99,8 @@ window.autosave = function() {
}
/**
* @summary Concatenates the title, content and excerpt.
*
* This is used to track changes when auto-saving.
* Concatenates the title, content and excerpt. This is used to track changes
* when auto-saving.
*
* @since 3.9.0
*
@ -118,7 +117,7 @@ window.autosave = function() {
}
/**
* @summary Disables save buttons.
* Disables save buttons.
*
* @since 3.9.0
*
@ -132,7 +131,7 @@ window.autosave = function() {
}
/**
* @summary Enables save buttons.
* Enables save buttons.
*
* @since 3.9.0
*
@ -143,7 +142,7 @@ window.autosave = function() {
}
/**
* @summary Gets the content editor.
* Gets the content editor.
*
* @since 4.6.0
*
@ -155,7 +154,7 @@ window.autosave = function() {
}
/**
* @summary Autosave in localStorage.
* Autosave in localStorage.
*
* @since 3.9.0
*
@ -176,7 +175,7 @@ window.autosave = function() {
isSuspended = false;
/**
* @summary Checks if the browser supports sessionStorage and it's not disabled.
* Checks if the browser supports sessionStorage and it's not disabled.
*
* @since 3.9.0
*
@ -197,7 +196,7 @@ window.autosave = function() {
}
/**
* @summary Initializes the local storage.
* Initializes the local storage.
*
* @since 3.9.0
*
@ -221,9 +220,8 @@ window.autosave = function() {
}
/**
* @summary Sets the storage for this blog.
*
* Confirms that the data was saved successfully.
* Sets the storage for this blog. Confirms that the data was saved
* successfully.
*
* @since 3.9.0
*
@ -242,7 +240,7 @@ window.autosave = function() {
}
/**
* @summary Gets the saved post data for the current post.
* Gets the saved post data for the current post.
*
* @since 3.9.0
*
@ -259,7 +257,7 @@ window.autosave = function() {
}
/**
* @summary Sets (save or delete) post data in the storage.
* Sets (save or delete) post data in the storage.
*
* If stored_data evaluates to 'false' the storage key for the current post will be removed.
*
@ -288,7 +286,7 @@ window.autosave = function() {
}
/**
* @summary Sets isSuspended to true.
* Sets isSuspended to true.
*
* @since 3.9.0
*
@ -299,7 +297,7 @@ window.autosave = function() {
}
/**
* @summary Sets isSuspended to false.
* Sets isSuspended to false.
*
* @since 3.9.0
*
@ -310,7 +308,7 @@ window.autosave = function() {
}
/**
* @summary Saves post data for the current post.
* Saves post data for the current post.
*
* Runs on a 15 sec. interval, saves when there are differences in the post title or content.
* When the optional data is provided, updates the last saved post data.
@ -359,7 +357,7 @@ window.autosave = function() {
}
/**
* @summary Initializes the auto save function.
* Initializes the auto save function.
*
* Checks whether the editor is active or not to use the editor events
* to autosave, or uses the values from the elements to autosave.
@ -419,9 +417,7 @@ window.autosave = function() {
}
/**
* @summary Compares 2 strings.
*
* Removes whitespaces in the strings before comparing them.
* Compares 2 strings. Removes whitespaces in the strings before comparing them.
*
* @since 3.9.0
*
@ -438,8 +434,8 @@ window.autosave = function() {
}
/**
* @summary Checks if the saved data for the current post (if any) is different
* than the loaded post data on the screen.
* Checks if the saved data for the current post (if any) is different than the
* loaded post data on the screen.
*
* Shows a standard message letting the user restore the post data if different.
*
@ -507,7 +503,7 @@ window.autosave = function() {
}
/**
* @summary Restores the current title, content and excerpt from postData.
* Restores the current title, content and excerpt from postData.
*
* @since 3.9.0
*
@ -575,7 +571,7 @@ window.autosave = function() {
}
/**
* @summary Auto saves the post on the server.
* Auto saves the post on the server.
*
* @since 3.9.0
*
@ -596,7 +592,7 @@ window.autosave = function() {
/**
* @summary Blocks saving for the next 10 seconds.
* Blocks saving for the next 10 seconds.
*
* @since 3.9.0
*
@ -612,7 +608,7 @@ window.autosave = function() {
}
/**
* @summary Sets isSuspended to true.
* Sets isSuspended to true.
*
* @since 3.9.0
*
@ -623,7 +619,7 @@ window.autosave = function() {
}
/**
* @summary Sets isSuspended to false.
* Sets isSuspended to false.
*
* @since 3.9.0
*
@ -634,7 +630,7 @@ window.autosave = function() {
}
/**
* @summary Triggers the autosave with the post data.
* Triggers the autosave with the post data.
*
* @since 3.9.0
*
@ -658,7 +654,7 @@ window.autosave = function() {
}
/**
* @summary Saves immediately.
* Saves immediately.
*
* Resets the timing and tells heartbeat to connect now.
*
@ -672,7 +668,7 @@ window.autosave = function() {
}
/**
* @summary Checks if the post content in the textarea has changed since page load.
* Checks if the post content in the textarea has changed since page load.
*
* This also happens when TinyMCE is active and editor.save() is triggered by
* wp.autosave.getPostData().
@ -686,7 +682,7 @@ window.autosave = function() {
}
/**
* @summary Checks if the post can be saved or not.
* Checks if the post can be saved or not.
*
* If the post hasn't changed or it cannot be updated,
* because the autosave is blocked or suspended, the function returns false.
@ -733,7 +729,7 @@ window.autosave = function() {
}
/**
* @summary Sets the next run, based on the autosave interval.
* Sets the next run, based on the autosave interval.
*
* @private
*
@ -746,7 +742,7 @@ window.autosave = function() {
}
/**
* @summary Sets the autosaveData on the autosave heartbeat.
* Sets the autosaveData on the autosave heartbeat.
*
* @since 3.9.0
*
@ -760,8 +756,8 @@ window.autosave = function() {
}
/**
* @summary Triggers the autosave of the post with the autosave data
* on the autosave heartbeat.
* Triggers the autosave of the post with the autosave data on the autosave
* heartbeat.
*
* @since 3.9.0
*
@ -772,7 +768,7 @@ window.autosave = function() {
response( data.wp_autosave );
}
/**
* @summary Disables buttons and throws a notice when the connection is lost.
* Disables buttons and throws a notice when the connection is lost.
*
* @since 3.9.0
*
@ -793,7 +789,7 @@ window.autosave = function() {
}
/**
* @summary Enables buttons when the connection is restored.
* Enables buttons when the connection is restored.
*
* @since 3.9.0
*
@ -816,7 +812,7 @@ window.autosave = function() {
}
/**
* @summary Sets the autosave time out.
* Sets the autosave time out.
*
* Wait for TinyMCE to initialize plus 1 second. for any external css to finish loading,
* then save to the textarea before setting initialCompareString.

2
wp-includes/js/comment-reply.js
View File

@ -1,5 +1,5 @@
/**
* @summary Handles the addition of the comment form.
* Handles the addition of the comment form.
*
* @since 2.7.0
*

22
wp-includes/js/media-audiovideo.js
View File

@ -73,7 +73,7 @@ var media = wp.media,
/**
*
* @summary Defines the wp.media.mixin object.
* Defines the wp.media.mixin object.
*
* @mixin
*
@ -83,7 +83,7 @@ wp.media.mixin = {
mejsSettings: baseSettings,
/**
* @summary Pauses and removes all players.
* Pauses and removes all players.
*
* @since 4.2.0
*
@ -101,7 +101,7 @@ wp.media.mixin = {
},
/**
* @summary Removes the player.
* Removes the player.
*
* Override the MediaElement method for removing a player.
* MediaElement tries to pull the audio/video tag out of
@ -147,7 +147,7 @@ wp.media.mixin = {
/**
*
* @summary Removes and resets all players.
* Removes and resets all players.
*
* Allows any class that has set 'player' to a MediaElementPlayer
* instance to remove the player when listening to events.
@ -168,7 +168,7 @@ wp.media.mixin = {
};
/**
* @summary Shortcode modeling for playlists.
* Shortcode modeling for playlists.
*
* @since 4.2.0
*/
@ -187,7 +187,7 @@ wp.media.playlist = new wp.media.collection({
});
/**
* @summary Shortcode modeling for audio.
* Shortcode modeling for audio.
*
* `edit()` prepares the shortcode for the media modal.
* `shortcode()` builds the new shortcode after an update.
@ -209,7 +209,7 @@ wp.media.audio = {
},
/**
* @summary Instantiates a new media object with the next matching shortcode.
* Instantiates a new media object with the next matching shortcode.
*
* @since 4.2.0
*
@ -229,7 +229,7 @@ wp.media.audio = {
},
/**
* @summary Generates an audio shortcode.
* Generates an audio shortcode.
*
* @since 4.2.0
*
@ -259,7 +259,7 @@ wp.media.audio = {
};
/**
* @summary Shortcode modeling for video.
* Shortcode modeling for video.
*
* `edit()` prepares the shortcode for the media modal.
* `shortcode()` builds the new shortcode after update.
@ -284,7 +284,7 @@ wp.media.video = {
},
/**
* @summary Instantiates a new media object with the next matching shortcode.
* Instantiates a new media object with the next matching shortcode.
*
* @since 4.2.0
*
@ -309,7 +309,7 @@ wp.media.video = {
},
/**
* @summary Generates an video shortcode.
* Generates an video shortcode.
*
* @since 4.2.0
*

12
wp-includes/js/media-views.js
View File

@ -2336,8 +2336,6 @@ Cropper = wp.media.controller.State.extend(/** @lends wp.media.controller.Croppe
},
/**
* @summary Opens the crop image window.
*
* Shows the crop image window when called from the Add new image button.
*
* @since 4.2.0
@ -2351,7 +2349,7 @@ Cropper = wp.media.controller.State.extend(/** @lends wp.media.controller.Croppe
},
/**
* @summary Changes the state of the toolbar window to browse mode.
* Changes the state of the toolbar window to browse mode.
*
* @since 4.2.0
*
@ -2362,7 +2360,7 @@ Cropper = wp.media.controller.State.extend(/** @lends wp.media.controller.Croppe
},
/**
* @summary Creates the crop image window.
* Creates the crop image window.
*
* Initialized when clicking on the Select and Crop button.
*
@ -2383,7 +2381,7 @@ Cropper = wp.media.controller.State.extend(/** @lends wp.media.controller.Croppe
},
/**
* @summary Removes the image selection and closes the cropping window.
* Removes the image selection and closes the cropping window.
*
* @since 4.2.0
*
@ -2397,7 +2395,7 @@ Cropper = wp.media.controller.State.extend(/** @lends wp.media.controller.Croppe
},
/**
* @summary Checks if cropping can be skipped and creates crop toolbar accordingly.
* Checks if cropping can be skipped and creates crop toolbar accordingly.
*
* @since 4.2.0
*
@ -2459,7 +2457,7 @@ Cropper = wp.media.controller.State.extend(/** @lends wp.media.controller.Croppe
},
/**
* @summary Creates an object with the image attachment and crop properties.
* Creates an object with the image attachment and crop properties.
*
* @since 4.2.0
*

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
*
* @global string $wp_version
*/
$wp_version = '5.0-alpha-42410';
$wp_version = '5.0-alpha-42411';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.