Changeset 37046

Timestamp:

03/22/2016 05:24:49 PM (10 years ago)

Author:

DrewAPicture

Message:

Docs: Improve inline documentation for property and methods in Walker_Category.

Props raimy for the initial patch.
See #36300.

File:

• trunk/src/wp-includes/class-walker-category.php (modified) (6 diffs)

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

@@ -16 +16 @@
  */
 class Walker_Category extends Walker {
+
         /**
          * What the class handles.
          *
+         * @since 2.1.0
+         * @access public
+         * @var string
+         *
          * @see Walker::$tree_type
-         * @since 2.1.0
-         * @var string
          */
         public $tree_type = 'category';
@@ -28 +31 @@
          * Database fields to use.
          *
-         * @see Walker::$db_fields
-         * @since 2.1.0
+         * @since 2.1.0
+         * @access public
          * @todo Decouple this
          * @var array
+         *
+         * @see Walker::$db_fields
          */
         public $db_fields = array ('parent' => 'parent', 'id' => 'term_id');
@@ -38 +43 @@
          * Starts the list before the elements are added.
          *
+         * @since 2.1.0
+         * @access public
+         *
          * @see Walker::start_lvl()
-         *
-         * @since 2.1.0
          *
          * @param string $output Passed by reference. Used to append additional content.
          * @param int    $depth  Depth of category. Used for tab indentation.
          * @param array  $args   An array of arguments. Will only append content if style argument value is 'list'.
-         *                       @see wp_list_categories()
+         *                       See wp_list_categories().
          */
         public function start_lvl( &$output, $depth = 0, $args = array() ) {
@@ -58 +64 @@
          * Ends the list of after the elements are added.
          *
+         * @since 2.1.0
+         * @access public
+         *
          * @see Walker::end_lvl()
-         *
-         * @since 2.1.0
          *
          * @param string $output Passed by reference. Used to append additional content.
          * @param int    $depth  Depth of category. Used for tab indentation.
          * @param array  $args   An array of arguments. Will only append content if style argument value is 'list'.
-         *                       @wsee wp_list_categories()
+         *                       See wp_list_categories().
          */
         public function end_lvl( &$output, $depth = 0, $args = array() ) {
@@ -76 +83 @@
 
         /**
-         * Start the element output.
+         * Starts the element output.
+         *
+         * @since 2.1.0
+         * @access public
          *
          * @see Walker::start_el()
-         *
-         * @since 2.1.0
          *
          * @param string $output   Passed by reference. Used to append additional content.
          * @param object $category Category data object.
          * @param int    $depth    Depth of category in reference to parents. Default 0.
-         * @param array  $args     An array of arguments. @see wp_list_categories()
+         * @param array  $args     An array of arguments. See wp_list_categories().
          * @param int    $id       ID of the current category.
          */
@@ -207 +215 @@
          * Ends the element output, if needed.
          *
+         * @since 2.1.0
+         * @access public
+         *
          * @see Walker::end_el()
-         *
-         * @since 2.1.0
          *
          * @param string $output Passed by reference. Used to append additional content.