Fill out inline documentation for magic methods added to the `Walker` class in [28514].

See #27881, #22234 and #28885.


git-svn-id: https://develop.svn.wordpress.org/trunk@29143 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes (DrewAPicture) 2014-07-13 23:40:14 +00:00
parent 77467c3095
commit 930db4b518
1 changed files with 20 additions and 13 deletions

View File

@ -16,8 +16,8 @@ class Walker {
* What the class handles.
*
* @since 2.1.0
* @var string
* @access public
* @var string
*/
public $tree_type;
@ -25,8 +25,8 @@ class Walker {
* DB fields to use.
*
* @since 2.1.0
* @var array
* @access protected
* @var array
*/
protected $db_fields;
@ -34,8 +34,8 @@ class Walker {
* Max number of pages walked by the paged walker
*
* @since 2.7.0
* @var int
* @access protected
* @var int
*/
protected $max_pages = 1;
@ -43,8 +43,8 @@ class Walker {
* Wether the current element has children or not. To be used in start_el()
*
* @since 4.0.0
* @var bool
* @access protected
* @var bool
*/
protected $has_children;
@ -52,8 +52,10 @@ class Walker {
* Make private properties readable for backwards compatibility
*
* @since 4.0.0
* @param string $name
* @return mixed
* @access public
*
* @param string $name Property to get.
* @return mixed Property.
*/
public function __get( $name ) {
return $this->$name;
@ -63,9 +65,11 @@ class Walker {
* Make private properties setable for backwards compatibility
*
* @since 4.0.0
* @param string $name
* @param string $value
* @return mixed
* @access public
*
* @param string $name Property to set.
* @param mixed $value Property value.
* @return mixed Newly-set property.
*/
public function __set( $name, $value ) {
return $this->$name = $value;
@ -75,8 +79,10 @@ class Walker {
* Make private properties checkable for backwards compatibility
*
* @since 4.0.0
* @param string $name
* @return mixed
* @access public
*
* @param string $name Property to check if set.
* @return bool Whether the property is set.
*/
public function __isset( $name ) {
return isset( $this->$name );
@ -86,8 +92,9 @@ class Walker {
* Make private properties unsetable for backwards compatibility
*
* @since 4.0.0
* @param string $name
* @return mixed
* @access public
*
* @param string $name Property to unset.
*/
public function __unset( $name ) {
unset( $this->$name );