Changeset 25588

Timestamp:

09/23/2013 11:28:41 PM (13 years ago)

Author:

DrewAPicture

Message:

Inline documentation for the Walker_Comment class in wp-includes/comment-template.php

Fixes #25388.

File:

• trunk/src/wp-includes/comment-template.php (modified) (11 diffs)

trunk/src/wp-includes/comment-template.php

@@ -1474 +1474 @@
 class Walker_Comment extends Walker {
     /**
+     * What the class handles.
+     *
      * @see Walker::$tree_type
+     *
      * @since 2.7.0
      * @var string
@@ -1481 +1484 @@
 
     /**
+     * DB fields to use.
+     *
      * @see Walker::$db_fields
+     *
      * @since 2.7.0
      * @var array
@@ -1488 +1494 @@
 
     /**
+     * Start the list before the elements are added.
+     *
      * @see Walker::start_lvl()
+     *
      * @since 2.7.0
      *
@@ -1512 +1521 @@
 
     /**
+     * End the list of items after the elements are added.
+     *
      * @see Walker::end_lvl()
+     *
      * @since 2.7.0
      *
      * @param string $output Passed by reference. Used to append additional content.
-     * @param int $depth Depth of comment.
-     * @param array $args Will only append content if style argument value is 'ol' or 'ul'.
+     * @param int    $depth  Depth of comment.
+     * @param array  $args   Will only append content if style argument value is 'ol' or 'ul'.
      */
     function end_lvl( &$output, $depth = 0, $args = array() ) {
@@ -1536 +1548 @@
 
     /**
+     * Traverse elements to create list from elements.
+     *
      * This function is designed to enhance Walker::display_element() to
      * display children of higher nesting levels than selected inline on
@@ -1552 +1566 @@
      *  2.2
      *
+     * @see Walker::display_element()
+     *
+     * @since 2.7.0
+     *
+     * @param object $element           Data object.
+     * @param array  $children_elements List of elements to continue traversing.
+     * @param int    $max_depth         Max depth to traverse.
+     * @param int    $depth             Depth of current element.
+     * @param array  $args              An array of arguments. @see wp_list_comments()
+     * @param string $output            Passed by reference. Used to append additional content.
+     * @return null Null on failure with no changes to parameters.
      */
     function display_element( $element, &$children_elements, $max_depth, $depth, $args, &$output ) {
@@ -1575 +1600 @@
 
     /**
+     * Start the element output.
+     *
      * @see Walker::start_el()
+     *
      * @since 2.7.0
      *
-     * @param string $output Passed by reference. Used to append additional content.
+     * @param string $output  Passed by reference. Used to append additional content.
      * @param object $comment Comment data object.
-     * @param int $depth Depth of comment in reference to parents.
-     * @param array $args
+     * @param int    $depth   Depth of comment in reference to parents.
+     * @param array  $args    An array of arguments. @see wp_list_comments()
      */
     function start_el( &$output, $comment, $depth = 0, $args = array(), $id = 0 ) {
@@ -1603 +1631 @@
 
     /**
+     * Ends the element output, if needed.
+     *
      * @see Walker::end_el()
+     *
      * @since 2.7.0
      *
-     * @param string $output Passed by reference. Used to append additional content.
-     * @param object $comment
-     * @param int $depth Depth of comment.
-     * @param array $args
+     * @param string $output  Passed by reference. Used to append additional content.
+     * @param object $comment The comment object. Default current comment.
+     * @param int    $depth   Depth of comment.
+     * @param array  $args    An array of arguments. @see wp_list_comments()
      */
     function end_el( &$output, $comment, $depth = 0, $args = array() ) {
@@ -1623 +1654 @@
 
     /**
-     * @since 3.6
+     * Output a pingback comment.
+     *
      * @access protected
-     *
-     * @param object $comment
-     * @param int $depth Depth of comment.
-     * @param array $args
+     * @since 3.6.0
+     *
+     * @param object $comment The comment object.
+     * @param int    $depth   Depth of comment.
+     * @param array  $args    An array of arguments. @see wp_list_comments()
      */
     protected function ping( $comment, $depth, $args ) {
@@ -1641 +1674 @@
 
     /**
-     * @since 3.6
+     * Output a single comment.
+     *
      * @access protected
+     * @since 3.6.0
      *
      * @param object $comment Comment to display.
-     * @param int $depth Depth of comment.
-     * @param array $args Optional args.
+     * @param int    $depth   Depth of comment.
+     * @param array  $args    An array of arguments. @see wp_list_comments()
      */
     protected function comment( $comment, $depth, $args ) {
@@ -1689 +1724 @@
 
     /**
-     * @since 3.6
+     * Output a comment in the HTML5 format.
+     *
      * @access protected
+     * @since 3.6.0
      *
      * @param object $comment Comment to display.
-     * @param int $depth Depth of comment.
-     * @param array $args Optional args.
+     * @param int    $depth   Depth of comment.
+     * @param array  $args    An array of arguments. @see wp_list_comments()
      */
     protected function html5_comment( $comment, $depth, $args ) {