vhad/wordpress-develop
1
0
Fork 0
mirror of https://github.com/gosticks/wordpress-develop.git synced 2026-08-11 20:30:23 +00:00
Code Issues Actions Packages 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.


git-svn-id: https://develop.svn.wordpress.org/trunk@42411 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Anton Timmermans
2017-12-18 14:13:58 +00:00
parent 05d60c580e
commit bc35d72a63
24 changed files with 338 additions and 371 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/wp-includes/js/autosave.js
+38 -42
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.
src/wp-includes/js/comment-reply.js
+1 -1
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
*
src/wp-includes/js/media-audiovideo.js
+11 -11
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
*
src/wp-includes/js/media-views.js
+5 -7
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
*
src/wp-includes/js/media/audiovideo.manifest.js
+11 -11
View File
@@ -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
*
src/wp-includes/js/media/controllers/cropper.js
+5 -7
View File
@@ -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
*