Changeset 30605

Timestamp:

11/28/2014 09:19:06 AM (12 years ago)

Author:

DrewAPicture

Message:

4.1 Docs Audit: Improve inline documentation for various properties and methods in the WP_Customize_Control and WP_Customize_Upload_Control classes.

See #30469.

File:

• trunk/src/wp-includes/class-wp-customize-control.php (modified) (4 diffs)

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

@@ -257 +257 @@
          * @since 4.1.0
          *
-         * @return array
+         * @return array Array of parameters passed to the JavaScript.
          */
         public function json() {
@@ -289 +289 @@
          * @since 4.1.0
          *
-         * @return string
+         * @return string Contents of the control.
          */
         public final function get_content() {
@@ -507 +507 @@
          * Render the control's JS template.
          *
-         * This function is only run for control types that have been registered with {@see WP_Customize_Manager::register_control_type()}.
-         *
-         * In the future, this will also print the template for the control's container element and be overridable.
+         * This function is only run for control types that have been registered with
+         * {@see WP_Customize_Manager::register_control_type()}.
+         *
+         * In the future, this will also print the template for the control's container
+         * element and be override-able.
          *
          * @since 4.1.0
@@ -649 +651 @@
          *
          * @since 4.1.0
-         * @uses WP_Customize_Control::__construct()
-         *
-         * @param WP_Customize_Manager $manager
+         *
+         * @param WP_Customize_Manager $manager {@see WP_Customize_Manager} instance.
          */
         public function __construct( $manager, $id, $args = array() ) {