Changeset 10373 for trunk/src/bp-groups/bp-groups-widgets.php

Timestamp:

11/22/2015 04:58:34 AM (9 years ago)

Author:

tw2113

Message:

More docs cleanup for BP-Groups component.

See #6401.

File:

• trunk/src/bp-groups/bp-groups-widgets.php (modified) (5 diffs)

trunk/src/bp-groups/bp-groups-widgets.php

@@ -10 +10 @@
 defined( 'ABSPATH' ) || exit;
 
-/* Register widgets for groups component */
+/**
+ * Register widgets for groups component
+ */
 function groups_register_widgets() {
     add_action('widgets_init', create_function('', 'return register_widget("BP_Groups_Widget");') );
@@ -16 +18 @@
 add_action( 'bp_register_widgets', 'groups_register_widgets' );
 
-/*** GROUPS WIDGET *****************/
-
+/**
+ * GROUPS WIDGET
+ */
 class BP_Groups_Widget extends WP_Widget {
+
+    /**
+     * Working as a group, we get things done better.
+     */
     function __construct() {
         $widget_ops = array(
@@ -41 +48 @@
     }
 
+    /**
+     * Extends our frontend output method.
+     *
+     * @param array $args     Array of arguments for the widget.
+     * @param array $instance Widget instance data.
+     */
     function widget( $args, $instance ) {
 
@@ -146 +159 @@
     }
 
+    /**
+     * Extends our update method.
+     *
+     * @param array $new_instance New instance data.
+     * @param array $old_instance Original instance data.
+     * @return array
+     */
     function update( $new_instance, $old_instance ) {
         $instance = $old_instance;
@@ -157 +177 @@
     }
 
+    /**
+     * Extends our form method.
+     *
+     * @param array $instance Current instance.
+     * @return mixed
+     */
     function form( $instance ) {
         $defaults = array(