Commit 02782894 authored by jhodgdon's avatar jhodgdon

Issue #2027351 by longwave, helenkim, YesCT: Tidy up grammar around arrays in menu.inc docs

parent cba80407
...@@ -446,7 +446,7 @@ function menu_set_item($path, $router_item) { ...@@ -446,7 +446,7 @@ function menu_set_item($path, $router_item) {
* Gets a router item. * Gets a router item.
* *
* @param $path * @param $path
* The path, for example node/5. The function will find the corresponding * The path; for example, 'node/5'. The function will find the corresponding
* node/% item and return that. * node/% item and return that.
* @param $router_item * @param $router_item
* Internal use only. * Internal use only.
...@@ -508,7 +508,7 @@ function menu_get_item($path = NULL, $router_item = NULL) { ...@@ -508,7 +508,7 @@ function menu_get_item($path = NULL, $router_item = NULL) {
* @param $item * @param $item
* A menu router or menu link item * A menu router or menu link item
* @param $map * @param $map
* An array of path arguments (ex: array('node', '5')) * An array of path arguments; for example, array('node', '5').
* *
* @return * @return
* Returns TRUE for success, FALSE if an object cannot be loaded. * Returns TRUE for success, FALSE if an object cannot be loaded.
...@@ -578,7 +578,7 @@ function _menu_load_objects(&$item, &$map) { ...@@ -578,7 +578,7 @@ function _menu_load_objects(&$item, &$map) {
* @param $item * @param $item
* A menu router or menu link item * A menu router or menu link item
* @param $map * @param $map
* An array of path arguments (ex: array('node', '5')) * An array of path arguments; for example, array('node', '5').
* *
* @return * @return
* $item['access'] becomes TRUE if the item is accessible, FALSE otherwise. * $item['access'] becomes TRUE if the item is accessible, FALSE otherwise.
...@@ -727,7 +727,7 @@ function _menu_item_localize(&$item, $map, $link_translate = FALSE) { ...@@ -727,7 +727,7 @@ function _menu_item_localize(&$item, $map, $link_translate = FALSE) {
* @param $router_item * @param $router_item
* A menu router item * A menu router item
* @param $map * @param $map
* An array of path arguments (ex: array('node', '5')) * An array of path arguments; for example, array('node', '5').
* @param $to_arg * @param $to_arg
* Execute $item['to_arg_functions'] or not. Use only if you want to render a * Execute $item['to_arg_functions'] or not. Use only if you want to render a
* path from the menu table, for example tabs. * path from the menu table, for example tabs.
...@@ -802,9 +802,9 @@ function _menu_translate(&$router_item, $map, $to_arg = FALSE) { ...@@ -802,9 +802,9 @@ function _menu_translate(&$router_item, $map, $to_arg = FALSE) {
* Translates the path elements in the map using any to_arg helper function. * Translates the path elements in the map using any to_arg helper function.
* *
* @param $map * @param $map
* An array of path arguments (ex: array('node', '5')) * An array of path arguments; for example, array('node', '5').
* @param $to_arg_functions * @param $to_arg_functions
* An array of helper function (ex: array(2 => 'menu_tail_to_arg')) * An array of helper functions; for example, array(2 => 'menu_tail_to_arg').
* *
* @see hook_menu() * @see hook_menu()
*/ */
...@@ -958,7 +958,7 @@ function _menu_link_translate(&$item, $translate = FALSE) { ...@@ -958,7 +958,7 @@ function _menu_link_translate(&$item, $translate = FALSE) {
* @param string $href * @param string $href
* Menu path as returned by $item['href'] of menu_get_item(). * Menu path as returned by $item['href'] of menu_get_item().
* @param array $map * @param array $map
* An array of path arguments, for example, array('node', '5'). * An array of path arguments; for example, array('node', '5').
* *
* @return bool * @return bool
* TRUE if the user has access or FALSE if the user should be presented * TRUE if the user has access or FALSE if the user should be presented
...@@ -2168,7 +2168,7 @@ function menu_local_tasks($level = 0) { ...@@ -2168,7 +2168,7 @@ function menu_local_tasks($level = 0) {
* example 'node' or 'admin/structure/block/manage'. * example 'node' or 'admin/structure/block/manage'.
* @param $args * @param $args
* A list of dynamic path arguments to append to $parent_path to form the * A list of dynamic path arguments to append to $parent_path to form the
* fully-qualified menu router path, for example array(123) for a certain * fully-qualified menu router path; for example, array(123) for a certain
* node or array('system', 'tools') for a certain block. * node or array('system', 'tools') for a certain block.
* *
* @return * @return
...@@ -2485,7 +2485,7 @@ function menu_set_active_trail($new_trail = NULL) { ...@@ -2485,7 +2485,7 @@ function menu_set_active_trail($new_trail = NULL) {
* Looks up the preferred menu link for a given system path. * Looks up the preferred menu link for a given system path.
* *
* @param $path * @param $path
* The path, for example 'node/5'. The function will find the corresponding * The path; for example, 'node/5'. The function will find the corresponding
* menu link ('node/5' if it exists, or fallback to 'node/%'). * menu link ('node/5' if it exists, or fallback to 'node/%').
* @param $selected_menu * @param $selected_menu
* The name of a menu used to restrict the search for a preferred menu link. * The name of a menu used to restrict the search for a preferred menu link.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment