diff options
Diffstat (limited to 'modules')
| -rw-r--r-- | modules/block.module | 6 | ||||
| -rw-r--r-- | modules/block/block.module | 6 | ||||
| -rw-r--r-- | modules/search.module | 27 | ||||
| -rw-r--r-- | modules/search/search.module | 27 | ||||
| -rw-r--r-- | modules/taxonomy.module | 10 | ||||
| -rw-r--r-- | modules/taxonomy/taxonomy.module | 10 |
6 files changed, 40 insertions, 46 deletions
diff --git a/modules/block.module b/modules/block.module index df91c0cb6..1ae859566 100644 --- a/modules/block.module +++ b/modules/block.module @@ -103,9 +103,9 @@ function block_admin_save($edit) { /** * update blocks db table with blocks currently exported by modules * - * @param array $order_by php array_multisort() style sort ordering, eg. "weight", SORT_ASC, SORT_STRING. see {@link http://www.php.net/manual/en/function.array-multisort.php} - * @return array blocks currently exported by modules, sorted by $order_by - * @access private + * @param $order_by php <a href="http://www.php.net/manual/en/function.array-multisort.php">array_multisort()</a> style sort ordering, eg. "weight", SORT_ASC, SORT_STRING. + * + * @return blocks currently exported by modules, sorted by $order_by */ function _block_rehash($order_by = array("weight")) { $result = db_query("SELECT * FROM {blocks} "); diff --git a/modules/block/block.module b/modules/block/block.module index df91c0cb6..1ae859566 100644 --- a/modules/block/block.module +++ b/modules/block/block.module @@ -103,9 +103,9 @@ function block_admin_save($edit) { /** * update blocks db table with blocks currently exported by modules * - * @param array $order_by php array_multisort() style sort ordering, eg. "weight", SORT_ASC, SORT_STRING. see {@link http://www.php.net/manual/en/function.array-multisort.php} - * @return array blocks currently exported by modules, sorted by $order_by - * @access private + * @param $order_by php <a href="http://www.php.net/manual/en/function.array-multisort.php">array_multisort()</a> style sort ordering, eg. "weight", SORT_ASC, SORT_STRING. + * + * @return blocks currently exported by modules, sorted by $order_by */ function _block_rehash($order_by = array("weight")) { $result = db_query("SELECT * FROM {blocks} "); diff --git a/modules/search.module b/modules/search.module index 9dedb035a..3d4d191da 100644 --- a/modules/search.module +++ b/modules/search.module @@ -64,7 +64,6 @@ function search_settings() { /** * search engine administration actions - * */ function search_admin() { $op = $_POST["op"]; @@ -90,8 +89,7 @@ function search_admin() { /** * perform a regularly run action across all modules that have the - * <module>_update_index function in them. - * + * <i>module</i>_update_index function in them. */ function search_cron() { foreach (module_list() as $module) { @@ -105,15 +103,16 @@ function search_cron() { } /** - * Perform a search on a word(s) + * Perform a search on a word(s). + * + * Search function called by each node that supports the indexed search. * - * Search function called by each node that supports the indexed search + * @param $search_array an array as returned from <i>module</i>_search + * of type array("keys" => ..., "type" => ..., "select" => ...) + * @see node_search for an explanation of array items * - * @param $search_array an array as returned from <module>_search - * of type array("keys" => ..., - * "type" => ..., "select" => ...) - * see node_search in node.module for an - * explanation of array items + * @return array of search results, each element being an array indexed with + * "count", "title", "link", "user" (name), "date", "keywords" */ function do_search($search_array) { @@ -225,11 +224,9 @@ function do_search($search_array) { /** * Update the search_index table * - * @param $search_array an array as returned from <module>_update_index - * of type array("last_update" => ..., - * "node_type" => ..., "select" => ...) - * see node_update_index in node.module for an - * explanation of array items + * @param $search_array an array as returned from <i>module</i>_update_index + * of type array("last_update" => ..., "node_type" => ..., "select" => ...) + * @see node_update_index for an explanation of array items */ function update_index($search_array) { $last_update = variable_get($search_array["last_update"], 1); diff --git a/modules/search/search.module b/modules/search/search.module index 9dedb035a..3d4d191da 100644 --- a/modules/search/search.module +++ b/modules/search/search.module @@ -64,7 +64,6 @@ function search_settings() { /** * search engine administration actions - * */ function search_admin() { $op = $_POST["op"]; @@ -90,8 +89,7 @@ function search_admin() { /** * perform a regularly run action across all modules that have the - * <module>_update_index function in them. - * + * <i>module</i>_update_index function in them. */ function search_cron() { foreach (module_list() as $module) { @@ -105,15 +103,16 @@ function search_cron() { } /** - * Perform a search on a word(s) + * Perform a search on a word(s). + * + * Search function called by each node that supports the indexed search. * - * Search function called by each node that supports the indexed search + * @param $search_array an array as returned from <i>module</i>_search + * of type array("keys" => ..., "type" => ..., "select" => ...) + * @see node_search for an explanation of array items * - * @param $search_array an array as returned from <module>_search - * of type array("keys" => ..., - * "type" => ..., "select" => ...) - * see node_search in node.module for an - * explanation of array items + * @return array of search results, each element being an array indexed with + * "count", "title", "link", "user" (name), "date", "keywords" */ function do_search($search_array) { @@ -225,11 +224,9 @@ function do_search($search_array) { /** * Update the search_index table * - * @param $search_array an array as returned from <module>_update_index - * of type array("last_update" => ..., - * "node_type" => ..., "select" => ...) - * see node_update_index in node.module for an - * explanation of array items + * @param $search_array an array as returned from <i>module</i>_update_index + * of type array("last_update" => ..., "node_type" => ..., "select" => ...) + * @see node_update_index for an explanation of array items */ function update_index($search_array) { $last_update = variable_get($search_array["last_update"], 1); diff --git a/modules/taxonomy.module b/modules/taxonomy.module index 135241f43..ca59cae25 100644 --- a/modules/taxonomy.module +++ b/modules/taxonomy.module @@ -538,12 +538,12 @@ function _taxonomy_term_children($tid) { } /** - * Try to map a string to existing vocabularies + * Try to map a string to existing vocabularies. * Provide case insensitive and trimmed map so as to * maximize likelihood of successful mapping. * - * @param string $name Name of the vocabulary to search - * @return array array of matching vocabularies, as objects + * @param $name Name of the vocabulary to search + * @return array of matching vocabularies, as objects */ function taxonomy_get_vocabulary_by_name($name) { // LOWER is ANSI SQL-92 @@ -561,8 +561,8 @@ function taxonomy_get_vocabulary_by_name($name) { * Provide case insensitive and trimmed map so as to * maximize likelihood of successful mapping. * - * @param string $name Name of the term to search - * @return array array of matching terms, as objects + * @param name Name of the term to search + * @return rray of matching terms, as objects */ function taxonomy_get_term_by_name($name) { // LOWER is ANSI SQL-92 diff --git a/modules/taxonomy/taxonomy.module b/modules/taxonomy/taxonomy.module index 135241f43..ca59cae25 100644 --- a/modules/taxonomy/taxonomy.module +++ b/modules/taxonomy/taxonomy.module @@ -538,12 +538,12 @@ function _taxonomy_term_children($tid) { } /** - * Try to map a string to existing vocabularies + * Try to map a string to existing vocabularies. * Provide case insensitive and trimmed map so as to * maximize likelihood of successful mapping. * - * @param string $name Name of the vocabulary to search - * @return array array of matching vocabularies, as objects + * @param $name Name of the vocabulary to search + * @return array of matching vocabularies, as objects */ function taxonomy_get_vocabulary_by_name($name) { // LOWER is ANSI SQL-92 @@ -561,8 +561,8 @@ function taxonomy_get_vocabulary_by_name($name) { * Provide case insensitive and trimmed map so as to * maximize likelihood of successful mapping. * - * @param string $name Name of the term to search - * @return array array of matching terms, as objects + * @param name Name of the term to search + * @return rray of matching terms, as objects */ function taxonomy_get_term_by_name($name) { // LOWER is ANSI SQL-92 |