Changeset 9906 for trunk/src/bp-groups/classes/class-bp-group-extension.php

Timestamp:

06/02/2015 05:21:07 AM (10 years ago)

Author:

tw2113

Message:

Initial documentation cleanup for the BP Groups component.

See #6401.

File:

• trunk/src/bp-groups/classes/class-bp-group-extension.php (modified) (4 diffs)

trunk/src/bp-groups/classes/class-bp-group-extension.php

@@ -290 +290 @@
      */
 
-    // The content of the group tab
+    /*
+     * The content of the group tab
+     *
+     * @param int|null $group_id
+     */
     public function display( $group_id = null ) {}
 
-    // Content displayed in a widget sidebar, if applicable
+    /**
+     * Content displayed in a widget sidebar, if applicable
+     */
     public function widget_display() {}
 
@@ -1084 +1090 @@
      *
      * @param string $screen The screen markup, captured in the output
-     *        buffer.
-     * @param string $screen The same markup, with a submit button added.
+     *                       buffer.
+     *
+     * @return string $screen The same markup, with a submit button added.
      */
     protected function maybe_add_submit_button( $screen = '' ) {
@@ -1119 +1126 @@
      * @since BuddyPress (2.1.0)
      *
-     * @param string $location
+     * @param string $redirect
+     *
      * @return string
      */
@@ -1674 +1682 @@
  *
  * @param string Name of the Extension class.
- * @return bool|null Returns false on failure, otherwise null.
+ * @return false|null Returns false on failure, otherwise null.
  */
 function bp_register_group_extension( $group_extension_class = '' ) {