WordPress.org

Make WordPress Core

Changeset 43141


Ignore:
Timestamp:
05/03/2018 02:39:25 PM (3 years ago)
Author:
atimmer
Message:

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

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

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/js/media/controllers/gallery-edit.js

    r42798 r43141  
    1717 * @memberOf wp.media.controller
    1818 *
    19  * @param {object}                     [attributes]                       The attributes hash passed to the state.
     19 * @param {Object}                     [attributes]                       The attributes hash passed to the state.
    2020 * @param {string}                     [attributes.id=gallery-edit]       Unique identifier.
    2121 * @param {string}                     [attributes.title=Edit Gallery]    Title for the state. Displays in the frame's title region.
     
    6060
    6161    /**
     62     * Initializes the library.
     63     *
     64     * Creates a selection if a library isn't supplied and creates an attachment
     65     * view if no attachment view is supplied.
     66     *
    6267     * @since 3.5.0
     68     *
     69     * @return {void}
    6370     */
    6471    initialize: function() {
     
    7784
    7885    /**
     86     * Activates the library.
     87     *
     88     * Limits the library to images, watches for uploaded attachments. Watches for
     89     * the browse event on the frame and binds it to gallerySettings.
     90     *
    7991     * @since 3.5.0
     92     *
     93     * @return {void}
    8094     */
    8195    activate: function() {
     
    94108
    95109    /**
     110     * Deactivates the library.
     111     *
     112     * Stops watching for uploaded attachments and browse events.
     113     *
    96114     * @since 3.5.0
     115     *
     116     * @return {void}
    97117     */
    98118    deactivate: function() {
     
    106126
    107127    /**
     128     * Adds the gallery settings to the sidebar and adds a reverse button to the
     129     * toolbar.
     130     *
    108131     * @since 3.5.0
    109132     *
    110      * @param browser
     133     * @param {wp.media.view.Frame} browser The file browser.
     134     *
     135     * @return {void}
    111136     */
    112137    gallerySettings: function( browser ) {
Note: See TracChangeset for help on using the changeset viewer.