WordPress.org

Make WordPress Core

Changeset 35929


Ignore:
Timestamp:
12/14/2015 06:05:06 PM (4 years ago)
Author:
DrewAPicture
Message:

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.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/class-walker-page.php

    r34441 r35929  
    1717class Walker_Page extends Walker {
    1818    /**
     19     * Walker tree type.
     20     *
     21     * @since 2.1.0
    1922     * @see Walker::$tree_type
    20      * @since 2.1.0
    2123     * @var string
    2224     */
     
    2426
    2527    /**
     28     * Database fields.
     29     *
     30     * @since 2.1.0
    2631     * @see Walker::$db_fields
    27      * @since 2.1.0
    2832     * @todo Decouple this.
    2933     * @var array
     
    3236
    3337    /**
    34      * @see Walker::start_lvl()
     38     * Outputs the beginning of the current level in the tree before elements are output.
     39     *
    3540     * @since 2.1.0
    3641     *
     42     * @see Walker::start_lvl()
     43     *
    3744     * @param string $output Passed by reference. Used to append additional content.
    38      * @param int    $depth  Depth of page. Used for padding.
    39      * @param array  $args
     45     * @param int    $depth  Optional. Depth of page. Used for padding. Default 0.
     46     * @param array  $args   Optional. Arguments for outputing the next level.
     47     *                       Default empty array.
    4048     */
    4149    public function start_lvl( &$output, $depth = 0, $args = array() ) {
     
    4553
    4654    /**
    47      * @see Walker::end_lvl()
     55     * Outputs the end of the current level in the tree after elements are output.
     56     *
    4857     * @since 2.1.0
    4958     *
     59     * @see Walker::end_lvl()
     60     *
    5061     * @param string $output Passed by reference. Used to append additional content.
    51      * @param int    $depth  Depth of page. Used for padding.
    52      * @param array  $args
     62     * @param int    $depth  Optional. Depth of page. Used for padding. Default 0.
     63     * @param array  $args   Optional. Arguments for outputting the end of the current level.
     64     *                       Default empty array.
    5365     */
    5466    public function end_lvl( &$output, $depth = 0, $args = array() ) {
     
    5870
    5971    /**
     72     * Outputs the beginning of the current element in the tree.
     73     *
    6074     * @see Walker::start_el()
    6175     * @since 2.1.0
     
    141155
    142156    /**
     157     * Outputs the end of the current element in the tree.
     158     *
     159     * @since 2.1.0
     160     *
    143161     * @see Walker::end_el()
    144      * @since 2.1.0
    145162     *
    146163     * @param string $output Passed by reference. Used to append additional content.
Note: See TracChangeset for help on using the changeset viewer.