Changeset 26556 for trunk/src/wp-content/themes/twentyfourteen/inc/widgets.php

Timestamp:

12/03/2013 05:05:53 PM (10 years ago)

Author:

lancewillett

Message:

Twenty Fourteen: update comment blocks to match inline docs standards. Props DrewAPicture, see #25837.

File:

• trunk/src/wp-content/themes/twentyfourteen/inc/widgets.php (modified) (4 diffs)

trunk/src/wp-content/themes/twentyfourteen/inc/widgets.php

@@ -17 +17 @@
      * The supported post formats.
      *
+     * @access private
      * @since Twenty Fourteen 1.0
      *
@@ -26 +27 @@
      * Pluralized post format strings.
      *
+     * @access private
      * @since Twenty Fourteen 1.0
      *
@@ -66 +68 @@
      * Output the HTML for this widget.
      *
-     * @since Twenty Fourteen 1.0
-     *
-     * @param array $args An array of standard parameters for widgets in this theme.
+     * @access public
+     * @since Twenty Fourteen 1.0
+     *
+     * @param array $args     An array of standard parameters for widgets in this theme.
      * @param array $instance An array of settings for this widget instance.
      * @return void Echoes its output.
@@ -220 +223 @@
 
     /**
-     * Deal with the settings when they are saved by the admin. Here is where
-     * any validation should happen.
-     *
-     * @since Twenty Fourteen 1.0
-     *
-     * @param array $new_instance
-     * @param array $instance
-     * @return array
+     * Deal with the settings when they are saved by the admin.
+     *
+     * Here is where any validation should happen.
+     *
+     * @since Twenty Fourteen 1.0
+     *
+     * @param array $new_instance New widget instance.
+     * @param array $instance     Original widget instance.
+     * @return array Updated widget instance.
      */
     function update( $new_instance, $instance ) {