WordPress.org
Get WordPress

Make WordPress Core

Changeset 37048


Ignore:
Timestamp:
03/22/2016 05:33:56 PM (9 years ago)
Author:
DrewAPicture
Message:

Docs: Improve inline documentation for properties and methods in Walker_Comment.

Props raimy for the initial patch.
See #36300.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-includes/class-walker-comment.php

    r35927 r37048  
    1111 * HTML comment list class.
    1212 *
    13  * @uses Walker
    1413 * @since 2.7.0
     14 *
     15 * @see Walker
    1516 */
    1617class Walker_Comment extends Walker {
     18
    1719    /**
    1820     * What the class handles.
    1921     *
     22     * @since 2.7.0
     23     * @access public
     24     * @var string
     25     *
    2026     * @see Walker::$tree_type
    21      *
    22      * @since 2.7.0
    23      * @var string
    2427     */
    2528    public $tree_type = 'comment';
    2629
    2730    /**
    28      * DB fields to use.
     31     * Database fields to use.
     32     *
     33     * @since 2.7.0
     34     * @access public
     35     * @var array
    2936     *
    3037     * @see Walker::$db_fields
    31      *
    32      * @since 2.7.0
    33      * @var array
     38     * @todo Decouple this
    3439     */
    3540    public $db_fields = array ('parent' => 'comment_parent', 'id' => 'comment_ID');
    3641
    3742    /**
    38      * Start the list before the elements are added.
     43     * Starts the list before the elements are added.
     44     *
     45     * @since 2.7.0
     46     * @access public
    3947     *
    4048     * @see Walker::start_lvl()
    41      *
    42      * @since 2.7.0
    43      *
    4449     * @global int $comment_depth
    4550     *
    … …  
    6570
    6671    /**
    67      * End the list of items after the elements are added.
     72     * Ends the list of items after the elements are added.
     73     *
     74     * @since 2.7.0
     75     * @access public
    6876     *
    6977     * @see Walker::end_lvl()
    70      *
    71      * @since 2.7.0
    72      *
    7378     * @global int $comment_depth
    7479     *
    … …  
    9499
    95100    /**
    96      * Traverse elements to create list from elements.
     101     * Traverses elements to create list from elements.
    97102     *
    98103     * This function is designed to enhance Walker::display_element() to
    … …  
    112117     *      2.2
    113118     *
     119     * @since 2.7.0
     120     * @access public
     121     *
    114122     * @see Walker::display_element()
    115123     * @see wp_list_comments()
    116      *
    117      * @since 2.7.0
    118124     *
    119125     * @param object $element           Data object.
    … …  
    148154
    149155    /**
    150      * Start the element output.
    151      *
    152      * @since 2.7.0
     156     * Starts the element output.
     157     *
     158     * @since 2.7.0
     159     * @access public
    153160     *
    154161     * @see Walker::start_el()
    155162     * @see wp_list_comments()
    156      *
    157163     * @global int        $comment_depth
    158164     * @global WP_Comment $comment
    … …  
    195201     *
    196202     * @since 2.7.0
     203     * @access public
    197204     *
    198205     * @see Walker::end_el()
    … …  
    218225
    219226    /**
    220      * Output a pingback comment.
    221      *
     227     * Outputs a pingback comment.
     228     *
     229     * @since 3.6.0
    222230     * @access protected
    223      * @since 3.6.0
    224231     *
    225232     * @see wp_list_comments()
    … …  
    240247
    241248    /**
    242      * Output a single comment.
    243      *
     249     * Outputs a single comment.
     250     *
     251     * @since 3.6.0
    244252     * @access protected
    245      * @since 3.6.0
    246253     *
    247254     * @see wp_list_comments()
    … …  
    299306
    300307    /**
    301      * Output a comment in the HTML5 format.
    302      *
     308     * Outputs a comment in the HTML5 format.
     309     *
     310     * @since 3.6.0
    303311     * @access protected
    304      * @since 3.6.0
    305312     *
    306313     * @see wp_list_comments()
Note: See TracChangeset for help on using the changeset viewer.