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

Timestamp:

01/18/2016 05:18:23 AM (9 years ago)

Author:

tw2113

Message:

Some more docs cleanup and plenty of @since tag additions for Groups Component.

See #6401.

File:

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

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

@@ -85 +85 @@
  * differently. The legacy method is still supported, though deprecated.
  *
- * @package BuddyPress
- * @subpackage Groups
  * @since 1.1.0
  */
@@ -144 +142 @@
      * The slug of the current extension.
      *
+     * @since 1.1.0
      * @var string
      */
@@ -151 +150 @@
      * The translatable name of the current extension.
      *
+     * @since 1.1.0
      * @var string
      */
@@ -158 +158 @@
      * The visibility of the extension tab. 'public' or 'private'.
      *
+     * @since 1.1.0
      * @var string
      */
@@ -165 +166 @@
      * The numeric position of the main nav item.
      *
+     * @since 1.1.0
      * @var int
      */
@@ -172 +174 @@
      * Whether to show the nav item.
      *
+     * @since 1.1.0
      * @var bool
      */
@@ -195 +198 @@
      * The text of the nav item. Defaults to self::name.
      *
+     * @since 1.1.0
      * @var string
      */
@@ -204 +208 @@
      * Default: 'groups_custom_group_boxes'.
      *
+     * @since 1.1.0
      * @var string
      */
@@ -213 +218 @@
      * Default: 'groups/single/plugins'.
      *
+     * @since 1.1.0
      * @var string
      */
@@ -273 +279 @@
      * The content of the group tab.
      *
+     * @since 1.1.0
+     *
      * @param int|null $group_id ID of the group to display.
      */
@@ -278 +286 @@
 
     /**
-     * Content displayed in a widget sidebar, if applicable
+     * Content displayed in a widget sidebar, if applicable.
+     *
+     * @since 1.1.0
      */
     public function widget_display() {}
@@ -652 +662 @@
      * Check whether the current user meets an access condition.
      *
+     * @since 2.1.0
+     *
      * @param string $access_condition 'anyone', 'loggedin', 'member',
      *                                 'mod', 'admin' or 'noone'.
@@ -759 +771 @@
     /**
      * Hook the main display method, and loads the template file.
+     *
+     * @since 1.1.0
      */
     public function _display_hook() {
@@ -1670 +1684 @@
  * Register a new Group Extension.
  *
+ * @since 1.1.0
+ *
  * @param string $group_extension_class Name of the Extension class.
  * @return false|null Returns false on failure, otherwise null.