Changeset 27370

Timestamp:

03/03/2014 06:10:22 AM (11 years ago)

Author:

DrewAPicture

Message:

Convert argument array documentation to the hash-notation style for WP_Admin_Bar::add_node() and WP_Admin_Bar::add_group().

Fixes #27258.

File:

• trunk/src/wp-includes/class-wp-admin-bar.php (modified) (2 diffs)

trunk/src/wp-includes/class-wp-admin-bar.php

@@ -82 +82 @@
      * Add a node to the menu.
      *
-     * @param array $args - The arguments for each node.
-     * - id         - string    - The ID of the item.
-     * - title      - string    - The title of the node.
-     * - parent     - string    - The ID of the parent node. Optional.
-     * - href       - string    - The link for the item. Optional.
-     * - group      - boolean   - If the node is a group. Optional. Default false.
-     * - meta       - array     - Meta data including the following keys: html, class, onclick, target, title, tabindex, rel.
+     * @param array $args {
+     *     Arguments for adding a node.
+     *
+     *     @type string $id     ID of the item.
+     *     @type string $title  Title of the node.
+     *     @type string $parent Optional. ID of the parent node.
+     *     @type string $href   Optional. Link for the item.
+     *     @type bool   $group  Optional. Whether or not the node is a group. Default false.
+     *     @type array  $meta   Meta data including the following keys: 'html', 'class', 'rel',
+     *                          'onclick', 'target', 'title', 'tabindex'. Default empty.
+     * }
      */
     public function add_node( $args ) {
@@ -188 +192 @@
      * @since 3.3.0
      *
-     * @param array $args - The arguments for each node.
-     * - id         - string    - The ID of the item.
-     * - parent     - string    - The ID of the parent node. Optional. Default root.
-     * - meta       - array     - Meta data including the following keys: class, onclick, target, title.
+     * @param array $args {
+     *     Array of arguments for adding a group.
+     *
+     *     @type string $id     ID of the item.
+     *     @type string $parent Optional. ID of the parent node. Default 'root'.
+     *     @type array  $meta   Meta data for the group including the following keys:
+     *                         'class', 'onclick', 'target', and 'title'.
+     * }
      */
     final public function add_group( $args ) {