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

Props raimy for the initial patch.
See #36300.


git-svn-id: https://develop.svn.wordpress.org/trunk@37053 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2016-03-22 17:50:35 +00:00
parent 39bdd5fc3d
commit eacd0d863d
1 changed files with 12 additions and 6 deletions

View File

@ -15,29 +15,35 @@
* @see Walker
*/
class Walker_PageDropdown extends Walker {
/**
* Walker tree type.
* What the class handles.
*
* @since 2.1.0
* @see Walker::$tree_type
* @access public
* @var string
*
* @see Walker::$tree_type
*/
public $tree_type = 'page';
/**
* Database fields.
* Database fields to use.
*
* @since 2.1.0
* @access public
* @var array
*
* @see Walker::$db_fields
* @todo Decouple this
* @var array
*/
public $db_fields = array ('parent' => 'post_parent', 'id' => 'ID');
public $db_fields = array( 'parent' => 'post_parent', 'id' => 'ID' );
/**
* Starts the element output.
*
* @since 2.1.0
* @access public
*
* @see Walker::start_el()
*
@ -47,7 +53,7 @@ class Walker_PageDropdown extends Walker {
* Default 0.
* @param array $args Optional. Uses 'selected' argument for selected page to set selected HTML
* attribute for option element. Uses 'value_field' argument to fill "value"
* attribute. See {@see wp_dropdown_pages()}. Default empty array.
* attribute. See wp_dropdown_pages(). Default empty array.
* @param int $id Optional. ID of the current page. Default 0 (unused).
*/
public function start_el( &$output, $page, $depth = 0, $args = array(), $id = 0 ) {