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

Props raimy.
See #36300.

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


git-svn-id: http://core.svn.wordpress.org/trunk@37022 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2016-03-22 18:04:26 +00:00
parent 3cdef41502
commit 773cb00210
2 changed files with 15 additions and 6 deletions

View File

@ -15,29 +15,35 @@
* @see Walker * @see Walker
*/ */
class Walker_Page extends Walker { class Walker_Page extends Walker {
/** /**
* Walker tree type. * What the class handles.
* *
* @since 2.1.0 * @since 2.1.0
* @see Walker::$tree_type * @access public
* @var string * @var string
*
* @see Walker::$tree_type
*/ */
public $tree_type = 'page'; public $tree_type = 'page';
/** /**
* Database fields. * Database fields to use.
* *
* @since 2.1.0 * @since 2.1.0
* @access private
* @var array
*
* @see Walker::$db_fields * @see Walker::$db_fields
* @todo Decouple this. * @todo Decouple this.
* @var array
*/ */
public $db_fields = array ('parent' => 'post_parent', 'id' => 'ID'); public $db_fields = array( 'parent' => 'post_parent', 'id' => 'ID' );
/** /**
* Outputs the beginning of the current level in the tree before elements are output. * Outputs the beginning of the current level in the tree before elements are output.
* *
* @since 2.1.0 * @since 2.1.0
* @access public
* *
* @see Walker::start_lvl() * @see Walker::start_lvl()
* *
@ -55,6 +61,7 @@ class Walker_Page extends Walker {
* Outputs the end of the current level in the tree after elements are output. * Outputs the end of the current level in the tree after elements are output.
* *
* @since 2.1.0 * @since 2.1.0
* @access public
* *
* @see Walker::end_lvl() * @see Walker::end_lvl()
* *
@ -73,6 +80,7 @@ class Walker_Page extends Walker {
* *
* @see Walker::start_el() * @see Walker::start_el()
* @since 2.1.0 * @since 2.1.0
* @access public
* *
* @param string $output Passed by reference. Used to append additional content. * @param string $output Passed by reference. Used to append additional content.
* @param object $page Page data object. * @param object $page Page data object.
@ -157,6 +165,7 @@ class Walker_Page extends Walker {
* Outputs the end of the current element in the tree. * Outputs the end of the current element in the tree.
* *
* @since 2.1.0 * @since 2.1.0
* @access public
* *
* @see Walker::end_el() * @see Walker::end_el()
* *

View File

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