sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Docs: Improve JSDoc for media/controllers/gallery-edit.js.

Browse Source 
Props Xyfi, nataliashitova, igorsch, ireneyoast, manuelaugustin.
Fixes #43866.


git-svn-id: https://develop.svn.wordpress.org/trunk@43141 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Anton Timmermans 2018-05-03 14:39:25 +00:00
parent 071cc142d3
commit 8c547ce521
1 changed files with 27 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
src/wp-includes/js/media/controllers/gallery-edit.js
View File

@ -16,7 +16,7 @@ var Library = wp.media.controller.Library,
*
* @memberOf wp.media.controller
*
* @param {object} [attributes] The attributes hash passed to the state.
* @param {Object} [attributes] The attributes hash passed to the state.
* @param {string} [attributes.id=gallery-edit] Unique identifier.
* @param {string} [attributes.title=Edit Gallery] Title for the state. Displays in the frame's title region.
* @param {wp.media.model.Attachments} [attributes.library] The collection of attachments in the gallery.
@ -59,7 +59,14 @@ GalleryEdit = Library.extend(/** @lends wp.media.controller.GalleryEdit.prototyp
},
/**
* Initializes the library.
*
* Creates a selection if a library isn't supplied and creates an attachment
* view if no attachment view is supplied.
*
* @since 3.5.0
*
* @return {void}
*/
initialize: function() {
// If we haven't been provided a `library`, create a `Selection`.
@ -76,7 +83,14 @@ GalleryEdit = Library.extend(/** @lends wp.media.controller.GalleryEdit.prototyp
},
/**
* Activates the library.
*
* Limits the library to images, watches for uploaded attachments. Watches for
* the browse event on the frame and binds it to gallerySettings.
*
* @since 3.5.0
*
* @return {void}
*/
activate: function() {
var library = this.get('library');
@ -93,7 +107,13 @@ GalleryEdit = Library.extend(/** @lends wp.media.controller.GalleryEdit.prototyp
},
/**
* Deactivates the library.
*
* Stops watching for uploaded attachments and browse events.
*
* @since 3.5.0
*
* @return {void}
*/
deactivate: function() {
// Stop watching for uploaded attachments.
@ -105,9 +125,14 @@ GalleryEdit = Library.extend(/** @lends wp.media.controller.GalleryEdit.prototyp
},
/**
* Adds the gallery settings to the sidebar and adds a reverse button to the
* toolbar.
*
* @since 3.5.0
*
* @param browser
* @param {wp.media.view.Frame} browser The file browser.
*
* @return {void}
*/
gallerySettings: function( browser ) {
if ( ! this.get('displaySettings') ) {