From a8fcffa02a782d3b22a55d83f9fc2b7e2ad9e811 Mon Sep 17 00:00:00 2001 From: Drew Jaynes Date: Fri, 28 Nov 2014 11:03:24 +0000 Subject: [PATCH] 4.1 Docs Audit: Improve inline documentation for various properties and methods in the `WP_Customize_Panel` class. See #30469. Built from https://develop.svn.wordpress.org/trunk@30607 git-svn-id: http://core.svn.wordpress.org/trunk@30597 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-includes/class-wp-customize-panel.php | 16 ++++++++-------- wp-includes/version.php | 2 +- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/wp-includes/class-wp-customize-panel.php b/wp-includes/class-wp-customize-panel.php index 7a5b36453a..c75341f7e5 100644 --- a/wp-includes/class-wp-customize-panel.php +++ b/wp-includes/class-wp-customize-panel.php @@ -110,7 +110,7 @@ class WP_Customize_Panel { public $type; /** - * Callback. + * Active callback. * * @since 4.1.0 * @access public @@ -118,8 +118,8 @@ class WP_Customize_Panel { * @see WP_Customize_Section::active() * * @var callable Callback is called with one argument, the instance of - * WP_Customize_Section, and returns bool to indicate whether - * the section is active (such as it relates to the URL + * {@see WP_Customize_Section}, and returns bool to indicate + * whether the section is active (such as it relates to the URL * currently being previewed). */ public $active_callback = ''; @@ -173,8 +173,8 @@ class WP_Customize_Panel { * * @since 4.1.0 * - * @param bool $active Whether the Customizer panel is active. - * @param WP_Customize_Panel $panel WP_Customize_Panel instance. + * @param bool $active Whether the Customizer panel is active. + * @param WP_Customize_Panel $panel {@see WP_Customize_Panel} instance. */ $active = apply_filters( 'customize_panel_active', $active, $panel ); @@ -182,7 +182,7 @@ class WP_Customize_Panel { } /** - * Default callback used when invoking WP_Customize_Panel::active(). + * Default callback used when invoking {@see WP_Customize_Panel::active()}. * * Subclasses can override this with their specific logic, or they may * provide an 'active_callback' argument to the constructor. @@ -201,7 +201,7 @@ class WP_Customize_Panel { * * @since 4.1.0 * - * @return array The array to be exported to the client as JSON + * @return array The array to be exported to the client as JSON. */ public function json() { $array = wp_array_slice_assoc( (array) $this, array( 'title', 'description', 'priority', 'type' ) ); @@ -236,7 +236,7 @@ class WP_Customize_Panel { * * @since 4.1.0 * - * @return string + * @return string Content for the panel. */ public final function get_content() { ob_start(); diff --git a/wp-includes/version.php b/wp-includes/version.php index 9b67c8740b..a70a7cbf44 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -4,7 +4,7 @@ * * @global string $wp_version */ -$wp_version = '4.1-beta2-30606'; +$wp_version = '4.1-beta2-30607'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.