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

Timestamp:

03/04/2017 06:26:55 PM (9 years ago)

Author:

tw2113

Message:

Cleanup from recent Scrutinizer review around documentation and param/return types.

File:

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

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

@@ -35 +35 @@
  * }
  * @param string       $component The component the navigation is attached to. Defaults to 'members'.
- * @return bool|null Returns false on failure.
+ * @return null|false Returns false on failure.
  */
 function bp_core_new_nav_item( $args, $component = 'members' ) {
@@ -109 +109 @@
  * }
  * @param string       $component Optional. Component that the nav belongs to.
- * @return bool|BP_Core_Nav_Item Returns false on failure, new nav item on success.
+ * @return false|array Returns false on failure, new nav item on success.
  */
 function bp_core_create_nav_link( $args = '', $component = 'members' ) {
@@ -191 +191 @@
  *                                                item is clicked.
  * }
- * @return bool|null Returns false on failure.
+ * @return false|null Returns false on failure.
  */
 function bp_core_register_nav_screen_function( $args = '' ) {
@@ -395 +395 @@
  *                                          Admin Bar menu for group admins. Default: false.
  * }
- * @param string       $component The component the navigation is attached to. Defaults to 'members'.
- * @return bool|null Returns false on failure.
+ * @param string|null    $component The component the navigation is attached to. Defaults to 'members'.
+ * @return null|false Returns false on failure.
  */
 function bp_core_new_subnav_item( $args, $component = null ) {
@@ -476 +476 @@
  * }
  * @param string       $component The component the navigation is attached to. Defaults to 'members'.
- * @return bool|object Returns false on failure, new BP_Core_Nav_Item instance on success.
+ * @return false|array Returns false on failure, new BP_Core_Nav_Item instance on success.
  */
 function bp_core_create_subnav_link( $args = '', $component = 'members' ) {
@@ -572 +572 @@
  * }
  * @param string       $component The component the navigation is attached to. Defaults to 'members'.
- * @return bool|null Returns false on failure.
+ * @return null|false Returns false on failure.
  */
 function bp_core_register_subnav_screen_function( $args = '', $component = 'members' ) {
@@ -776 +776 @@
  * @since 2.6.0 Introduced the `$component` parameter.
  *
- * @param string $slug      The slug of the primary navigation item.
- * @param string $component The component the navigation is attached to. Defaults to 'members'.
+ * @param string      $slug      The slug of the primary navigation item.
+ * @param string|null $component The component the navigation is attached to. Defaults to 'members'.
  * @return bool Returns false on failure, True on success.
  */
@@ -824 +824 @@
  * @since 2.6.0 Introduced the `$component` parameter.
  *
- * @param string $parent_slug The slug of the primary navigation item.
- * @param string $slug        The slug of the secondary item to be removed.
- * @param string $component   The component the navigation is attached to. Defaults to 'members'.
+ * @param string      $parent_slug The slug of the primary navigation item.
+ * @param string      $slug        The slug of the secondary item to be removed.
+ * @param string|null $component   The component the navigation is attached to. Defaults to 'members'.
  * @return bool Returns false on failure, True on success.
  */