Changeset 10899 for trunk/src/bp-core/classes/class-bp-core-nav.php

Timestamp:

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

Author:

tw2113

Message:

Many PHPDocs cleanup for Core component.

See #6398.

File:

• trunk/src/bp-core/classes/class-bp-core-nav.php (modified) (10 diffs)

trunk/src/bp-core/classes/class-bp-core-nav.php

@@ -5 +5 @@
  * @package BuddyPress
  * @subpackage Core
- * @since  2.6.0
+ * @since 2.6.0
  */
 
@@ -57 +57 @@
      * @since 2.6.0
      *
-     * @param  string $key The requested nav slug.
+     * @param string $key The requested nav slug.
      * @return bool True if the nav item is set, false otherwise.
      */
@@ -69 +69 @@
      * @since 2.6.0
      *
-     * @param  string $key The requested nav slug.
+     * @param string $key The requested nav slug.
      * @return mixed The value corresponding to the requested nav item.
      */
@@ -85 +85 @@
      * @since 2.6.0
      *
-     * @param  string  $key   The requested nav slug.
-     * @param  mixed   $value The value of the nav item.
+     * @param string $key   The requested nav slug.
+     * @param mixed  $value The value of the nav item.
      */
     public function __set( $key, $value ) {
@@ -101 +101 @@
      * @since 2.6.0
      *
-     * @param  string $key The nav item slug to get. Optional.
+     * @param string $key The nav item slug to get. Optional.
      * @return mixed       An array of nav item, a single nav item, or null if none found.
      */
@@ -321 +321 @@
      * @since 2.6.0
      *
-     * @param  array $args Filters to select the specific primary items. See wp_list_filter().
-     * @param  bool  $sort True to sort the nav items. False otherwise.
+     * @param array $args Filters to select the specific primary items. See wp_list_filter().
+     * @param bool  $sort True to sort the nav items. False otherwise.
      * @return array The list of primary objects nav
      */
@@ -328 +328 @@
         $params = wp_parse_args( $args, array( 'primary' => true ) );
 
-        // This parameter is not overridable
+        // This parameter is not overridable.
         if ( empty( $params['primary'] ) ) {
             return false;
@@ -351 +351 @@
      * @since 2.6.0
      *
-     * @param  array $args Filters to select the specific secondary items. See wp_list_filter().
-     * @param  bool  $sort True to sort the nav items. False otherwise.
+     * @param array $args Filters to select the specific secondary items. See wp_list_filter().
+     * @param bool  $sort True to sort the nav items. False otherwise.
      * @return array The list of secondary objects nav
      */
@@ -358 +358 @@
         $params = wp_parse_args( $args, array( 'parent_slug' => '' ) );
 
-        // No need to search children if the parent is not set
+        // No need to search children if the parent is not set.
         if ( empty( $params['parent_slug'] ) && empty( $params['secondary'] ) ) {
             return false;
@@ -388 +388 @@
         if ( $primary_nav_items ) {
             foreach( $primary_nav_items as $key_nav => $primary_nav ) {
-                // Try to get the children
+                // Try to get the children.
                 $children = $this->get_secondary( array( 'parent_slug' => $primary_nav->slug, 'user_has_access' => true ) );