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

Timestamp:

07/12/2015 12:49:36 AM (11 years ago)

Author:

tw2113

Message:

First pass at BP-Core docs cleanup.

See #6398.

File:

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

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

@@ -50 +50 @@
          * @see Walker::walk()
          *
-         * @param array $elements See {@link Walker::walk()}.
-         * @param int $max_depth See {@link Walker::walk()}.
+         * @param array $elements  See {@link Walker::walk()}.
+         * @param int   $max_depth See {@link Walker::walk()}.
+         *
          * @return string See {@link Walker::walk()}.
          */
@@ -79 +80 @@
 
                 /*
-                 * need to display in hierarchical order
+                 * Need to display in hierarchical order
                  * separate elements into two buckets: top level and children elements
                  * children_elements is two dimensional array, eg.
@@ -96 +97 @@
 
                 /*
-                 * when none of the elements is top level
-                 * assume the first one must be root of the sub elements
+                 * When none of the elements is top level
+                 * assume the first one must be root of the sub elements.
                  */
                 if ( empty( $top_level_elements ) ) {
@@ -135 +136 @@
          * Display the current <li> that we are on.
          *
-         * @see Walker::start_el() for complete description of parameters .
+         * @see Walker::start_el() for complete description of parameters.
          *
          * @since BuddyPress (1.7.0)
          *
          * @param string $output Passed by reference. Used to append
-         *        additional content.
-         * @param object $item Menu item data object.
-         * @param int $depth Depth of menu item. Used for padding. Optional,
-         *        defaults to 0.
-         * @param array $args Optional. See {@link Walker::start_el()}.
-         * @param int $current_page Menu item ID. Optional.
+         *                       additional content.
+         * @param object $item   Menu item data object.
+         * @param int    $depth  Depth of menu item. Used for padding. Optional,
+         *                       defaults to 0.
+         * @param array  $args   Optional. See {@link Walker::start_el()}.
+         * @param int    $id     Menu item ID. Optional.
          */
         public function start_el( &$output, $item, $depth = 0, $args = array(), $id = 0 ) {