WordPress.org
Get WordPress

Make WordPress Core


Ignore:
Timestamp:
11/29/2019 05:59:47 PM (4 years ago)
Author:
SergeyBiryukov
Message:

Docs: Replace @returns tags in JS docs with @return.

Per the documentation standards, @returns is an unsupported synonym, @return should be used instead:
​https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/javascript/

See #48303.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/js/_enqueues/admin/inline-edit-tax.js

    r43577 r46800  
    3030     * @this inlineEditTax
    3131     * @memberof inlineEditTax
    32      * @returns {void}
     32     * @return {void}
    3333     */
    3434    init : function() {
    … …  
    9797     * @param {HTMLElement} el An element within the table row or the table row
    9898     *                         itself that we want to quick edit.
    99      * @returns {void}
     99     * @return {void}
    100100     */
    101101    toggle : function(el) {
    … …  
    116116     *                                element within the table row or the
    117117     * table row itself.
    118      * @returns {boolean} Always returns false.
     118     * @return {boolean} Always returns false.
    119119     */
    120120    edit : function(id) {
    … …  
    163163     *                                element within the table row or the
    164164     * table row itself.
    165      * @returns {boolean} Always returns false.
     165     * @return {boolean} Always returns false.
    166166     */
    167167    save : function(id) {
    … …  
    256256     * @this inlineEditTax
    257257     * @memberof inlineEditTax
    258      * @returns {void}
     258     * @return {void}
    259259     */
    260260    revert : function() {
    … …  
    281281     *
    282282     * @param {HTMLElement} o An element within the table row or the table row itself.
    283      * @returns {string} The ID of the term based on the element.
     283     * @return {string} The ID of the term based on the element.
    284284     */
    285285    getId : function(o) {
Note: See TracChangeset for help on using the changeset viewer.