From f32fba3dab0338afa2f6fc851ff7924ce2a16158 Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Mon, 14 Dec 2015 18:06:31 +0000 Subject: [PATCH] Docs: Add more complete property and method documentation for `Walker_Page`. * Adds missing DocBlock summaries * Adds missing `@param` descriptions * Marks some optional parameters as such * Reorders some DocBlock tags See #32246. Built from https://develop.svn.wordpress.org/trunk@35929 git-svn-id: http://core.svn.wordpress.org/trunk@35893 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-includes/class-walker-page.php | 35 +++++++++++++++++++++++-------- wp-includes/version.php | 2 +- 2 files changed, 27 insertions(+), 10 deletions(-) diff --git a/wp-includes/class-walker-page.php b/wp-includes/class-walker-page.php index 3b3ca3189d..119ea6e7bc 100644 --- a/wp-includes/class-walker-page.php +++ b/wp-includes/class-walker-page.php @@ -16,27 +16,35 @@ */ class Walker_Page extends Walker { /** - * @see Walker::$tree_type + * Walker tree type. + * * @since 2.1.0 + * @see Walker::$tree_type * @var string */ public $tree_type = 'page'; /** - * @see Walker::$db_fields + * Database fields. + * * @since 2.1.0 + * @see Walker::$db_fields * @todo Decouple this. * @var array */ public $db_fields = array ('parent' => 'post_parent', 'id' => 'ID'); /** - * @see Walker::start_lvl() + * Outputs the beginning of the current level in the tree before elements are output. + * * @since 2.1.0 * + * @see Walker::start_lvl() + * * @param string $output Passed by reference. Used to append additional content. - * @param int $depth Depth of page. Used for padding. - * @param array $args + * @param int $depth Optional. Depth of page. Used for padding. Default 0. + * @param array $args Optional. Arguments for outputing the next level. + * Default empty array. */ public function start_lvl( &$output, $depth = 0, $args = array() ) { $indent = str_repeat("\t", $depth); @@ -44,12 +52,16 @@ class Walker_Page extends Walker { } /** - * @see Walker::end_lvl() + * Outputs the end of the current level in the tree after elements are output. + * * @since 2.1.0 * + * @see Walker::end_lvl() + * * @param string $output Passed by reference. Used to append additional content. - * @param int $depth Depth of page. Used for padding. - * @param array $args + * @param int $depth Optional. Depth of page. Used for padding. Default 0. + * @param array $args Optional. Arguments for outputting the end of the current level. + * Default empty array. */ public function end_lvl( &$output, $depth = 0, $args = array() ) { $indent = str_repeat("\t", $depth); @@ -57,6 +69,8 @@ class Walker_Page extends Walker { } /** + * Outputs the beginning of the current element in the tree. + * * @see Walker::start_el() * @since 2.1.0 * @@ -140,9 +154,12 @@ class Walker_Page extends Walker { } /** - * @see Walker::end_el() + * Outputs the end of the current element in the tree. + * * @since 2.1.0 * + * @see Walker::end_el() + * * @param string $output Passed by reference. Used to append additional content. * @param object $page Page data object. Not used. * @param int $depth Depth of page. Not Used. diff --git a/wp-includes/version.php b/wp-includes/version.php index 7de16bfc63..706d9bd9b9 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -4,7 +4,7 @@ * * @global string $wp_version */ -$wp_version = '4.5-alpha-35928'; +$wp_version = '4.5-alpha-35929'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.