Changeset 10899 for trunk/src/bp-core/bp-core-buddybar.php

Timestamp:

06/23/2016 06:31:58 AM (10 years ago)

Author:

tw2113

Message:

Many PHPDocs cleanup for Core component.

See #6398.

File:

• trunk/src/bp-core/bp-core-buddybar.php (modified) (7 diffs)

trunk/src/bp-core/bp-core-buddybar.php

@@ -34 +34 @@
  *                                                item is clicked.
  * }
- * @param string $component The component the navigation is attached to. Defaults to 'members'.
+ * @param string       $component The component the navigation is attached to. Defaults to 'members'.
  * @return bool|null Returns false on failure.
  */
@@ -108 +108 @@
  *                                                item is clicked.
  * }
- * @param string $component Optional. Component that the nav belongs to.
+ * @param string       $component Optional. Component that the nav belongs to.
  * @return bool|BP_Nav_Item Returns false on failure, new nav item on success.
  */
@@ -322 +322 @@
         }
 
-        // Edit the screen function for the parent nav
+        // Edit the screen function for the parent nav.
         $bp->members->nav->edit_nav( array(
                 'screen_function'     => &$r['screen_function'],
@@ -395 +395 @@
  *                                          Admin Bar menu for group admins. Default: false.
  * }
- * @param string $component The component the navigation is attached to. Defaults to 'members'.
+ * @param string       $component The component the navigation is attached to. Defaults to 'members'.
  * @return bool|null Returns false on failure.
  */
@@ -406 +406 @@
                  * a) the 'parent_slug' is the same as the slug of the current group, or
                  * b) the 'parent_slug' starts with the slug of the current group, and the members nav doesn't have
-                 *    a primary item with that slug
+                 *    a primary item with that slug.
                  */
                 $group_slug = bp_get_current_group_slug();
@@ -475 +475 @@
  *                                          Default: false.
  * }
- * @param string $component The component the navigation is attached to. Defaults to 'members'.
- * @return bool|BP_Nav_Item Returns false on failure, new nav item on success.
+ * @param string       $component The component the navigation is attached to. Defaults to 'members'.
+ * @return bool|object Returns false on failure, new BP_Nav_Item instance on success.
  */
 function bp_core_create_subnav_link( $args = '', $component = 'members' ) {
@@ -569 +569 @@
  *                                       Default: false.
  * }
- * @param string $component The component the navigation is attached to. Defaults to 'members'.
+ * @param string       $component The component the navigation is attached to. Defaults to 'members'.
  * @return bool|null Returns false on failure.
  */