Changeset 37065

Timestamp:

03/23/2016 05:31:31 AM (11 years ago)

Author:

DrewAPicture

Message:

Docs: Improve inline documentation syntax throughout WP_Widget.

Fixes #36298.

File:

• trunk/src/wp-includes/class-wp-widget.php (modified) (13 diffs)

trunk/src/wp-includes/class-wp-widget.php

@@ -38 +38 @@
 
         /**
-         * Option array passed to {@see wp_register_sidebar_widget()}.
+         * Option array passed to wp_register_sidebar_widget().
          *
          * @since 2.8.0
@@ -47 +47 @@
 
         /**
-         * Option array passed to {@see wp_register_widget_control()}.
+         * Option array passed to wp_register_widget_control().
          *
          * @since 2.8.0
@@ -85 +85 @@
         public $updated = false;
 
-        // Member functions that you must over-ride.
+        //
+        // Member functions that must be overriden by subclasses.
+        //
 
         /**
@@ -184 +186 @@
          * Constructs name attributes for use in form() fields
          *
-         * This function should be used in form() methods to create name attributes for fields to be saved by update()
+         * This function should be used in form() methods to create name attributes for fields
+         * to be saved by update()
          *
          * @since 2.8.0
@@ -202 +205 @@
 
         /**
-         * Constructs id attributes for use in {@see WP_Widget::form()} fields.
+         * Constructs id attributes for use in WP_Widget::form() fields.
          *
          * This function should be used in form() methods to create id attributes
-         * for fields to be saved by {@see WP_Widget::update()}.
+         * for fields to be saved by WP_Widget::update().
          *
          * @since 2.8.0
@@ -251 +254 @@
 
         /**
-         * Set the internal order number for the widget instance.
+         * Sets the internal order number for the widget instance.
          *
          * @since 2.8.0
@@ -301 +304 @@
 
         /**
-         * Determine whether the current request is inside the Customizer preview.
+         * Determines whether the current request is inside the Customizer preview.
          *
          * If true -- the current request is inside the Customizer preview, then
@@ -321 +324 @@
 
         /**
-         * Generate the actual widget content (Do NOT override).
-         *
-         * Finds the instance and calls {@see WP_Widget::widget()}.
-         *
-         * @since 2.8.0
-         * @access public
-         *
-         * @param array     $args        Display arguments. See {@see WP_Widget::widget()} for information
+         * Generates the actual widget content (Do NOT override).
+         *
+         * Finds the instance and calls WP_Widget::widget().
+         *
+         * @since 2.8.0
+         * @access public
+         *
+         * @param array     $args        Display arguments. See WP_Widget::widget() for information
          *                               on accepted arguments.
          * @param int|array $widget_args {
@@ -380 +383 @@
 
         /**
-         * Deal with changed settings (Do NOT override).
+         * Handles changed settings (Do NOT override).
          *
          * @since 2.8.0
@@ -465 +468 @@
 
         /**
-         * Generate the widget control form (Do NOT override).
+         * Generates the widget control form (Do NOT override).
          *
          * @since 2.8.0
@@ -532 +535 @@
 
         /**
-         * Register an instance of the widget class.
+         * Registers an instance of the widget class.
          *
          * @since 2.8.0
@@ -547 +550 @@
 
         /**
-         * Save the settings for all instances of the widget class.
+         * Saves the settings for all instances of the widget class.
          *
          * @since 2.8.0
@@ -560 +563 @@
 
         /**
-         * Get the settings for all instances of the widget class.
+         * Retrieves the settings for all instances of the widget class.
          *
          * @since 2.8.0