From 28072f473a9fc94245dc249c32525253254a8aef Mon Sep 17 00:00:00 2001 From: "Drew Jaynes (DrewAPicture)" Date: Fri, 28 Nov 2014 11:02:49 +0000 Subject: [PATCH] 4.1 Docs Audit: Improve inline documentation for various properties and methods in the `WP_Customize_Panel` class. See #30469. git-svn-id: https://develop.svn.wordpress.org/trunk@30607 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/class-wp-customize-panel.php | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/src/wp-includes/class-wp-customize-panel.php b/src/wp-includes/class-wp-customize-panel.php index 7a5b36453a..c75341f7e5 100644 --- a/src/wp-includes/class-wp-customize-panel.php +++ b/src/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();