Changeset 37048

Timestamp:

03/22/2016 05:33:56 PM (10 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:

• trunk/src/wp-includes/class-walker-comment.php (modified) (9 diffs)

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

@@ -11 +11 @@
  * HTML comment list class.
  *
- * @uses Walker
  * @since 2.7.0
+ *
+ * @see Walker
  */
 class Walker_Comment extends Walker {
+
         /**
          * What the class handles.
          *
+         * @since 2.7.0
+         * @access public
+         * @var string
+         *
          * @see Walker::$tree_type
-         *
-         * @since 2.7.0
-         * @var string
          */
         public $tree_type = 'comment';
 
         /**
-         * DB fields to use.
+         * Database fields to use.
+         *
+         * @since 2.7.0
+         * @access public
+         * @var array
          *
          * @see Walker::$db_fields
-         *
-         * @since 2.7.0
-         * @var array
+         * @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.
+         *
+         * @since 2.7.0
+         * @access public
          *
          * @see Walker::start_lvl()
-         *
-         * @since 2.7.0
-         *
          * @global int $comment_depth
          *
@@ -65 +70 @@
 
         /**
-         * End the list of items after the elements are added.
+         * Ends the list of items after the elements are added.
+         *
+         * @since 2.7.0
+         * @access public
          *
          * @see Walker::end_lvl()
-         *
-         * @since 2.7.0
-         *
          * @global int $comment_depth
          *
@@ -94 +99 @@
 
         /**
-         * Traverse elements to create list from elements.
+         * Traverses elements to create list from elements.
          *
          * This function is designed to enhance Walker::display_element() to
@@ -112 +117 @@
          *      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.
@@ -148 +154 @@
 
         /**
-         * Start the element output.
-         *
-         * @since 2.7.0
+         * 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
@@ -195 +201 @@
          *
          * @since 2.7.0
+         * @access public
          *
          * @see Walker::end_el()
@@ -218 +225 @@
 
         /**
-         * Output a pingback comment.
-         *
+         * Outputs a pingback comment.
+         *
+         * @since 3.6.0
          * @access protected
-         * @since 3.6.0
          *
          * @see wp_list_comments()
@@ -240 +247 @@
 
         /**
-         * Output a single comment.
-         *
+         * Outputs a single comment.
+         *
+         * @since 3.6.0
          * @access protected
-         * @since 3.6.0
          *
          * @see wp_list_comments()
@@ -299 +306 @@
 
         /**
-         * Output a comment in the HTML5 format.
-         *
+         * Outputs a comment in the HTML5 format.
+         *
+         * @since 3.6.0
          * @access protected
-         * @since 3.6.0
          *
          * @see wp_list_comments()