WordPress.org

Make WordPress Core

Changeset 43391


Ignore:
Timestamp:
07/05/2018 02:06:01 PM (2 years ago)
Author:
atimmer
Message:

Docs: Fix default values for customize/controls.js.

The old values cannot be parsed by JSDoc.

Props herregroen.
Fixes #44520.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/js/_enqueues/wp/customize/controls.js

    r43347 r43391  
    939939         * @borrows wp.customize~focus as focus
    940940         *
    941          * @param {string}         id - The ID for the container.
    942          * @param {object}         options - Object containing one property: params.
    943          * @param {string}         options.title - Title shown when panel is collapsed and expanded.
    944          * @param {string=}        [options.description] - Description shown at the top of the panel.
    945          * @param {number=100}     [options.priority] - The sort priority for the panel.
    946          * @param {string}         [options.templateId] - Template selector for container.
    947          * @param {string=default} [options.type] - The type of the panel. See wp.customize.panelConstructor.
    948          * @param {string=}        [options.content] - The markup to be used for the panel container. If empty, a JS template is used.
    949          * @param {boolean=true}   [options.active] - Whether the panel is active or not.
    950          * @param {object}         [options.params] - Deprecated wrapper for the above properties.
     941         * @param {string}  id - The ID for the container.
     942         * @param {object}  options - Object containing one property: params.
     943         * @param {string}  options.title - Title shown when panel is collapsed and expanded.
     944         * @param {string}  [options.description] - Description shown at the top of the panel.
     945         * @param {number}  [options.priority=100] - The sort priority for the panel.
     946         * @param {string}  [options.templateId] - Template selector for container.
     947         * @param {string}  [options.type=default] - The type of the panel. See wp.customize.panelConstructor.
     948         * @param {string}  [options.content] - The markup to be used for the panel container. If empty, a JS template is used.
     949         * @param {boolean} [options.active=true] - Whether the panel is active or not.
     950         * @param {object}  [options.params] - Deprecated wrapper for the above properties.
    951951         */
    952952        initialize: function ( id, options ) {
     
    14071407         * @since 4.1.0
    14081408         *
    1409          * @param {string}         id - The ID for the section.
    1410          * @param {object}         options - Options.
    1411          * @param {string}         options.title - Title shown when section is collapsed and expanded.
    1412          * @param {string=}        [options.description] - Description shown at the top of the section.
    1413          * @param {number=100}     [options.priority] - The sort priority for the section.
    1414          * @param {string=default} [options.type] - The type of the section. See wp.customize.sectionConstructor.
    1415          * @param {string=}        [options.content] - The markup to be used for the section container. If empty, a JS template is used.
    1416          * @param {boolean=true}   [options.active] - Whether the section is active or not.
    1417          * @param {string}         options.panel - The ID for the panel this section is associated with.
    1418          * @param {string=}        [options.customizeAction] - Additional context information shown before the section title when expanded.
    1419          * @param {object}         [options.params] - Deprecated wrapper for the above properties.
     1409         * @param {string}  id - The ID for the section.
     1410         * @param {object}  options - Options.
     1411         * @param {string}  options.title - Title shown when section is collapsed and expanded.
     1412         * @param {string}  [options.description] - Description shown at the top of the section.
     1413         * @param {number}  [options.priority=100] - The sort priority for the section.
     1414         * @param {string}  [options.type=default] - The type of the section. See wp.customize.sectionConstructor.
     1415         * @param {string}  [options.content] - The markup to be used for the section container. If empty, a JS template is used.
     1416         * @param {boolean} [options.active=true] - Whether the section is active or not.
     1417         * @param {string}  options.panel - The ID for the panel this section is associated with.
     1418         * @param {string}  [options.customizeAction] - Additional context information shown before the section title when expanded.
     1419         * @param {object}  [options.params] - Deprecated wrapper for the above properties.
    14201420         */
    14211421        initialize: function ( id, options ) {
     
    27572757         * @since 4.1.0
    27582758         *
    2759          * @param {string}         id - The ID for the panel.
    2760          * @param {object}         options - Object containing one property: params.
    2761          * @param {string}         options.title - Title shown when panel is collapsed and expanded.
    2762          * @param {string=}        [options.description] - Description shown at the top of the panel.
    2763          * @param {number=100}     [options.priority] - The sort priority for the panel.
    2764          * @param {string=default} [options.type] - The type of the panel. See wp.customize.panelConstructor.
    2765          * @param {string=}        [options.content] - The markup to be used for the panel container. If empty, a JS template is used.
    2766          * @param {boolean=true}   [options.active] - Whether the panel is active or not.
    2767          * @param {object}         [options.params] - Deprecated wrapper for the above properties.
     2759         * @param {string}  id - The ID for the panel.
     2760         * @param {object}  options - Object containing one property: params.
     2761         * @param {string}  options.title - Title shown when panel is collapsed and expanded.
     2762         * @param {string}  [options.description] - Description shown at the top of the panel.
     2763         * @param {number}  [options.priority=100] - The sort priority for the panel.
     2764         * @param {string}  [options.type=default] - The type of the panel. See wp.customize.panelConstructor.
     2765         * @param {string}  [options.content] - The markup to be used for the panel container. If empty, a JS template is used.
     2766         * @param {boolean} [options.active=true] - Whether the panel is active or not.
     2767         * @param {object}  [options.params] - Deprecated wrapper for the above properties.
    27682768         */
    27692769        initialize: function ( id, options ) {
Note: See TracChangeset for help on using the changeset viewer.