`. * When removing selection markers an empty `
` 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
tags with two line breaks. "Opposite" of wpautop(). + * Replaces
tags with two line breaks. "Opposite" of wpautop(). * * Replaces
tags with two line breaks except where the
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
.
+ * Replaces two line breaks with a paragraph tag and one line break with a
.
*
* 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
*
diff --git a/src/wp-admin/js/image-edit.js b/src/wp-admin/js/image-edit.js
index e3278e0dcc..a47ddc7299 100644
--- a/src/wp-admin/js/image-edit.js
+++ b/src/wp-admin/js/image-edit.js
@@ -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
diff --git a/src/wp-admin/js/inline-edit-post.js b/src/wp-admin/js/inline-edit-post.js
index a5b052c25e..b49ac03c1b 100644
--- a/src/wp-admin/js/inline-edit-post.js
+++ b/src/wp-admin/js/inline-edit-post.js
@@ -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
diff --git a/src/wp-admin/js/inline-edit-tax.js b/src/wp-admin/js/inline-edit-tax.js
index 797001780d..17ce77c83d 100644
--- a/src/wp-admin/js/inline-edit-tax.js
+++ b/src/wp-admin/js/inline-edit-tax.js
@@ -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.
diff --git a/src/wp-admin/js/media.js b/src/wp-admin/js/media.js
index 4bd91d5b7e..3a87726115 100644
--- a/src/wp-admin/js/media.js
+++ b/src/wp-admin/js/media.js
@@ -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}
*/
diff --git a/src/wp-admin/js/post.js b/src/wp-admin/js/post.js
index f8c2baf4f0..553d3999f3 100644
--- a/src/wp-admin/js/post.js
+++ b/src/wp-admin/js/post.js
@@ -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.
*
diff --git a/src/wp-admin/js/postbox.js b/src/wp-admin/js/postbox.js
index 97d8ab6e4e..a91b536eb6 100644
--- a/src/wp-admin/js/postbox.js
+++ b/src/wp-admin/js/postbox.js
@@ -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
diff --git a/src/wp-admin/js/tags.js b/src/wp-admin/js/tags.js
index c35efaa177..ed1c68bc8e 100644
--- a/src/wp-admin/js/tags.js
+++ b/src/wp-admin/js/tags.js
@@ -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.
*
diff --git a/src/wp-admin/js/word-count.js b/src/wp-admin/js/word-count.js
index 6b319ccf2a..711268aed6 100644
--- a/src/wp-admin/js/word-count.js
+++ b/src/wp-admin/js/word-count.js
@@ -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
*
diff --git a/src/wp-content/themes/twentyfifteen/js/functions.js b/src/wp-content/themes/twentyfifteen/js/functions.js
index 2da5cbc340..b9dddc85be 100644
--- a/src/wp-content/themes/twentyfifteen/js/functions.js
+++ b/src/wp-content/themes/twentyfifteen/js/functions.js
@@ -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
diff --git a/src/wp-content/themes/twentyfourteen/js/functions.js b/src/wp-content/themes/twentyfourteen/js/functions.js
index a21849ec35..ac4629d77e 100644
--- a/src/wp-content/themes/twentyfourteen/js/functions.js
+++ b/src/wp-content/themes/twentyfourteen/js/functions.js
@@ -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
diff --git a/src/wp-content/themes/twentythirteen/js/functions.js b/src/wp-content/themes/twentythirteen/js/functions.js
index 88e8d0b5a7..1b18180c20 100644
--- a/src/wp-content/themes/twentythirteen/js/functions.js
+++ b/src/wp-content/themes/twentythirteen/js/functions.js
@@ -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() {
diff --git a/src/wp-includes/js/autosave.js b/src/wp-includes/js/autosave.js
index afd51fbbdb..919bc15471 100644
--- a/src/wp-includes/js/autosave.js
+++ b/src/wp-includes/js/autosave.js
@@ -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.
diff --git a/src/wp-includes/js/comment-reply.js b/src/wp-includes/js/comment-reply.js
index 76c5fba700..4626e627b8 100644
--- a/src/wp-includes/js/comment-reply.js
+++ b/src/wp-includes/js/comment-reply.js
@@ -1,5 +1,5 @@
/**
- * @summary Handles the addition of the comment form.
+ * Handles the addition of the comment form.
*
* @since 2.7.0
*
diff --git a/src/wp-includes/js/media-audiovideo.js b/src/wp-includes/js/media-audiovideo.js
index e939d49454..9eb3d5c017 100644
--- a/src/wp-includes/js/media-audiovideo.js
+++ b/src/wp-includes/js/media-audiovideo.js
@@ -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
*
diff --git a/src/wp-includes/js/media-views.js b/src/wp-includes/js/media-views.js
index c0d3003beb..32bdcbd455 100644
--- a/src/wp-includes/js/media-views.js
+++ b/src/wp-includes/js/media-views.js
@@ -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
*
diff --git a/src/wp-includes/js/media/audiovideo.manifest.js b/src/wp-includes/js/media/audiovideo.manifest.js
index 7981aa75ac..c1e4c59f8e 100644
--- a/src/wp-includes/js/media/audiovideo.manifest.js
+++ b/src/wp-includes/js/media/audiovideo.manifest.js
@@ -4,7 +4,7 @@ var media = wp.media,
/**
*
- * @summary Defines the wp.media.mixin object.
+ * Defines the wp.media.mixin object.
*
* @mixin
*
@@ -14,7 +14,7 @@ wp.media.mixin = {
mejsSettings: baseSettings,
/**
- * @summary Pauses and removes all players.
+ * Pauses and removes all players.
*
* @since 4.2.0
*
@@ -32,7 +32,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
@@ -78,7 +78,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.
@@ -99,7 +99,7 @@ wp.media.mixin = {
};
/**
- * @summary Shortcode modeling for playlists.
+ * Shortcode modeling for playlists.
*
* @since 4.2.0
*/
@@ -118,7 +118,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.
@@ -140,7 +140,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
*
@@ -160,7 +160,7 @@ wp.media.audio = {
},
/**
- * @summary Generates an audio shortcode.
+ * Generates an audio shortcode.
*
* @since 4.2.0
*
@@ -190,7 +190,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.
@@ -215,7 +215,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
*
@@ -240,7 +240,7 @@ wp.media.video = {
},
/**
- * @summary Generates an video shortcode.
+ * Generates an video shortcode.
*
* @since 4.2.0
*
diff --git a/src/wp-includes/js/media/controllers/cropper.js b/src/wp-includes/js/media/controllers/cropper.js
index be4b7bc53a..3418064a61 100644
--- a/src/wp-includes/js/media/controllers/cropper.js
+++ b/src/wp-includes/js/media/controllers/cropper.js
@@ -27,8 +27,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
@@ -42,7 +40,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
*
@@ -53,7 +51,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.
*
@@ -74,7 +72,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
*
@@ -88,7 +86,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
*
@@ -150,7 +148,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
*