Changeset 10355 for trunk/src/bp-core/classes/class-bp-walker-nav-menu.php

Timestamp:

11/15/2015 07:13:42 PM (11 years ago)

Author:

tw2113

Message:

More documentation cleanup for part of BP-Core component.

See #6398.

File:

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

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

@@ -52 +52 @@
          * @param array $elements  See {@link Walker::walk()}.
          * @param int   $max_depth See {@link Walker::walk()}.
-         *
          * @return string See {@link Walker::walk()}.
          */
@@ -61 +60 @@
                 $output = '';
 
-                if ( $max_depth < -1 ) // invalid parameter
+                if ( $max_depth < -1 ) // Invalid parameter.
                         return $output;
 
-                if ( empty( $elements ) ) // nothing to walk
+                if ( empty( $elements ) ) // Nothing to walk.
                         return $output;
 
                 $parent_field = $this->db_fields['parent'];
 
-                // flat display
+                // Flat display.
                 if ( -1 == $max_depth ) {
 
@@ -119 +118 @@
 
                 /*
-                 * if we are displaying all levels, and remaining children_elements is not empty,
-                 * then we got orphans, which should be displayed regardless
+                 * If we are displaying all levels, and remaining children_elements is not empty,
+                 * then we got orphans, which should be displayed regardless.
                  */
                 if ( ( $max_depth == 0 ) && count( $children_elements ) > 0 ) {
@@ -149 +148 @@
          */
         public function start_el( &$output, $item, $depth = 0, $args = array(), $id = 0 ) {
-                // If we're someway down the tree, indent the HTML with the appropriate number of tabs
+                // If we're someway down the tree, indent the HTML with the appropriate number of tabs.
                 $indent = $depth ? str_repeat( "\t", $depth ) : '';
 
@@ -165 +164 @@
 
                 // Add HTML ID
-                $id = sanitize_html_class( $item->css_id . '-personal-li' );  // Backpat with BP pre-1.7
+                $id = sanitize_html_class( $item->css_id . '-personal-li' );  // Backpat with BP pre-1.7.
 
                 /**
@@ -182 +181 @@
                 $output .= $indent . '<li' . $id . $class_names . '>';
 
-                // Add href attribute
+                // Add href attribute.
                 $attributes = ! empty( $item->link ) ? ' href="' . esc_url( $item->link ) . '"' : '';
 
-                // Construct the link
+                // Construct the link.
                 $item_output = $args->before;
                 $item_output .= '<a' . $attributes . '>';