Changeset 30607 for trunk/src/wp-includes/class-wp-customize-panel.php

Timestamp:

11/28/2014 11:02:49 AM (11 years ago)

Author:

DrewAPicture

Message:

4.1 Docs Audit: Improve inline documentation for various properties and methods in the WP_Customize_Panel class.

See #30469.

File:

• trunk/src/wp-includes/class-wp-customize-panel.php (modified) (6 diffs)

trunk/src/wp-includes/class-wp-customize-panel.php

@@ -111 +111 @@
 
     /**
-     * Callback.
+     * Active callback.
      *
      * @since 4.1.0
@@ -119 +119 @@
      *
      * @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).
      */
@@ -174 +174 @@
          * @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 );
@@ -183 +183 @@
 
     /**
-     * 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
@@ -202 +202 @@
      * @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() {
@@ -237 +237 @@
      * @since 4.1.0
      *
-     * @return string
+     * @return string Content for the panel.
      */
     public final function get_content() {