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

Props raimy for the initial patch.
See #36300.

Built from https://develop.svn.wordpress.org/trunk@37048


git-svn-id: http://core.svn.wordpress.org/trunk@37015 1a063a9b-81f0-0310-95a4-ce76da25c4cd

wp-includes/class-walker-comment.php

@@ -10,37 +10,42 @@
 /**
  * HTML comment list class.
  *
- * @uses Walker
  * @since 2.7.0
+ *
+ * @see Walker
  */
 class Walker_Comment extends Walker {
+
 	/**
 	 * What the class handles.
 	 *
-	 * @see Walker::$tree_type
-	 *
 	 * @since 2.7.0
+	 * @access public
 	 * @var string
+	 *
+	 * @see Walker::$tree_type
 	 */
 	public $tree_type = 'comment';
 
 	/**
-	 * DB fields to use.
+	 * Database fields to use.
-	 *
-	 * @see Walker::$db_fields
 	 *
 	 * @since 2.7.0
+	 * @access public
 	 * @var array
+	 *
+	 * @see Walker::$db_fields
+	 * @todo Decouple this
 	 */
 	public $db_fields = array ('parent' => 'comment_parent', 'id' => 'comment_ID');
 
 	/**
-	 * Start the list before the elements are added.
+	 * Starts the list before the elements are added.
-	 *
-	 * @see Walker::start_lvl()
 	 *
 	 * @since 2.7.0
+	 * @access public
 	 *
+	 * @see Walker::start_lvl()
 	 * @global int $comment_depth
 	 *
 	 * @param string $output Passed by reference. Used to append additional content.
@@ -64,12 +69,12 @@ class Walker_Comment extends Walker {
 	}
 
 	/**
-	 * End the list of items after the elements are added.
+	 * Ends the list of items after the elements are added.
-	 *
-	 * @see Walker::end_lvl()
 	 *
 	 * @since 2.7.0
+	 * @access public
 	 *
+	 * @see Walker::end_lvl()
 	 * @global int $comment_depth
 	 *
 	 * @param string $output Passed by reference. Used to append additional content.
@@ -93,7 +98,7 @@ class Walker_Comment extends Walker {
 	}
 
 	/**
-	 * Traverse elements to create list from elements.
+	 * Traverses 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
@@ -111,11 +116,12 @@ class Walker_Comment extends Walker {
 	 *     2
 	 *      2.2
 	 *
+	 * @since 2.7.0
+	 * @access public
+	 *
 	 * @see Walker::display_element()
 	 * @see wp_list_comments()
 	 *
-	 * @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.
@@ -147,13 +153,13 @@ class Walker_Comment extends Walker {
 	}
 
 	/**
-	 * Start the element output.
+	 * Starts the element output.
 	 *
 	 * @since 2.7.0
+	 * @access public
 	 *
 	 * @see Walker::start_el()
 	 * @see wp_list_comments()
-	 *
 	 * @global int        $comment_depth
 	 * @global WP_Comment $comment
 	 *
@@ -194,6 +200,7 @@ class Walker_Comment extends Walker {
 	 * Ends the element output, if needed.
 	 *
 	 * @since 2.7.0
+	 * @access public
 	 *
 	 * @see Walker::end_el()
 	 * @see wp_list_comments()
@@ -217,10 +224,10 @@ class Walker_Comment extends Walker {
 	}
 
 	/**
-	 * Output a pingback comment.
+	 * Outputs a pingback comment.
 	 *
-	 * @access protected
 	 * @since 3.6.0
+	 * @access protected
 	 *
 	 * @see wp_list_comments()
 	 *
@@ -239,10 +246,10 @@ class Walker_Comment extends Walker {
 	}
 
 	/**
-	 * Output a single comment.
+	 * Outputs a single comment.
 	 *
-	 * @access protected
 	 * @since 3.6.0
+	 * @access protected
 	 *
 	 * @see wp_list_comments()
 	 *
@@ -298,10 +305,10 @@ class Walker_Comment extends Walker {
 	}
 
 	/**
-	 * Output a comment in the HTML5 format.
+	 * Outputs a comment in the HTML5 format.
 	 *
-	 * @access protected
 	 * @since 3.6.0
+	 * @access protected
 	 *
 	 * @see wp_list_comments()
 	 *

wp-includes/version.php

@@ -4,7 +4,7 @@
  *
  * @global string $wp_version
  */
-$wp_version = '4.5-beta4-37047';
+$wp_version = '4.5-beta4-37048';
 
 /**
  * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.