diff options
Diffstat (limited to 'modules')
| -rw-r--r-- | modules/block.module | 14 | ||||
| -rw-r--r-- | modules/block/block.module | 14 | ||||
| -rw-r--r-- | modules/comment.module | 5 | ||||
| -rw-r--r-- | modules/comment/comment.module | 5 | ||||
| -rw-r--r-- | modules/forum.module | 68 | ||||
| -rw-r--r-- | modules/forum/forum.module | 68 | ||||
| -rw-r--r-- | modules/node.module | 10 | ||||
| -rw-r--r-- | modules/node/node.module | 10 | ||||
| -rw-r--r-- | modules/search.module | 18 | ||||
| -rw-r--r-- | modules/search/search.module | 18 | ||||
| -rw-r--r-- | modules/taxonomy.module | 18 | ||||
| -rw-r--r-- | modules/taxonomy/taxonomy.module | 18 |
12 files changed, 136 insertions, 130 deletions
diff --git a/modules/block.module b/modules/block.module index 1746a61cc..1fa5673ea 100644 --- a/modules/block.module +++ b/modules/block.module @@ -101,9 +101,11 @@ function block_admin_save($edit) { /** * update blocks db table with blocks currently exported by modules * - * @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. + * @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 + * @return blocks currently exported by modules, sorted by $order_by */ function _block_rehash($order_by = array("weight")) { $result = db_query("SELECT * FROM {blocks} "); @@ -355,13 +357,13 @@ function block_user($type, &$edit, &$user) { /** * Return blocks available for current $user at $region. * - * @param $region main|left|right + * @param $region main|left|right * - * @return array of block objects, indexed with <i>module</i>_<i>delta</i> + * @return array of block objects, indexed with <i>module</i>_<i>delta</i> * - * @see <a href="http://drupal.org/node/view/1042" target="_top">[feature] + * @see <a href="http://drupal.org/node/view/1042" target="_top">[feature] * Generic template design difficult w/o block region "look-ahead"</a> - * @todo add a proper primary key (bid) to the blocks table so we don't have + * @todo add a proper primary key (bid) to the blocks table so we don't have * to mess around with this <i>module</i>_<i>delta</i> construct. currently, * "blocks" has no primary key defined (bad)! */ diff --git a/modules/block/block.module b/modules/block/block.module index 1746a61cc..1fa5673ea 100644 --- a/modules/block/block.module +++ b/modules/block/block.module @@ -101,9 +101,11 @@ function block_admin_save($edit) { /** * update blocks db table with blocks currently exported by modules * - * @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. + * @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 + * @return blocks currently exported by modules, sorted by $order_by */ function _block_rehash($order_by = array("weight")) { $result = db_query("SELECT * FROM {blocks} "); @@ -355,13 +357,13 @@ function block_user($type, &$edit, &$user) { /** * Return blocks available for current $user at $region. * - * @param $region main|left|right + * @param $region main|left|right * - * @return array of block objects, indexed with <i>module</i>_<i>delta</i> + * @return array of block objects, indexed with <i>module</i>_<i>delta</i> * - * @see <a href="http://drupal.org/node/view/1042" target="_top">[feature] + * @see <a href="http://drupal.org/node/view/1042" target="_top">[feature] * Generic template design difficult w/o block region "look-ahead"</a> - * @todo add a proper primary key (bid) to the blocks table so we don't have + * @todo add a proper primary key (bid) to the blocks table so we don't have * to mess around with this <i>module</i>_<i>delta</i> construct. currently, * "blocks" has no primary key defined (bad)! */ diff --git a/modules/comment.module b/modules/comment.module index 6e7ab5471..34e5f039a 100644 --- a/modules/comment.module +++ b/modules/comment.module @@ -1531,8 +1531,9 @@ function comment_num_replies($pid) { /** * get number of new comments for current user and specified node * - * @param $nid node-id to count comments for - * @param $timestamp time to count from (defaults to time of last user access to node) + * @param $nid node-id to count comments for + * @param $timestamp time to count from (defaults to time of last user access + * to node) */ function comment_num_new($nid, $timestamp = 0) { global $user; diff --git a/modules/comment/comment.module b/modules/comment/comment.module index 6e7ab5471..34e5f039a 100644 --- a/modules/comment/comment.module +++ b/modules/comment/comment.module @@ -1531,8 +1531,9 @@ function comment_num_replies($pid) { /** * get number of new comments for current user and specified node * - * @param $nid node-id to count comments for - * @param $timestamp time to count from (defaults to time of last user access to node) + * @param $nid node-id to count comments for + * @param $timestamp time to count from (defaults to time of last user access + * to node) */ function comment_num_new($nid, $timestamp = 0) { global $user; diff --git a/modules/forum.module b/modules/forum.module index eaedf11e2..23c545f8a 100644 --- a/modules/forum.module +++ b/modules/forum.module @@ -459,23 +459,23 @@ function forum_page() { } /** - @addtogroup themeable - @{ -**/ + * @addtogroup themeable + * @{ + */ /** - Format the forum body. - - @param forums - @param topics - @param parents - @param tid - @param sortby - @param forum_per_page - @param offset - - @return the output for the forum body. -**/ + * Format the forum body. + * + * @param forums + * @param topics + * @param parents + * @param tid + * @param sortby + * @param forum_per_page + * @param offset + * + * @return the output for the forum body. + */ function theme_forum_display($forums, $topics, $parents, $tid, $sortby, $forum_per_page, $offset) { // forum list, topics list, topic browser and "add new topic" link @@ -519,14 +519,14 @@ function theme_forum_display($forums, $topics, $parents, $tid, $sortby, $forum_p } /** - Format the forum listing. - - @param forums - @param parents - @param tid - - @return output for the forum listing. -**/ + * Format the forum listing. + * + * @param forums + * @param parents + * @param tid + * + * @return output for the forum listing. + */ function theme_forum_list($forums, $parents, $tid) { global $user; @@ -582,16 +582,16 @@ function theme_forum_list($forums, $parents, $tid) { } /** - Format the topic listing. - - @param tid - @param topics - @param sortby - @param forum_per_page - @param offset - - @return output for the topic list. -**/ + * Format the topic listing. + * + * @param tid + * @param topics + * @param sortby + * @param forum_per_page + * @param offset + * + * @return output for the topic list. + */ function theme_forum_topic_list($tid, $topics, $sortby, $forum_per_page, $offset) { global $id, $status, $user, $pager_total, $forum_topic_list_header; @@ -632,7 +632,7 @@ function theme_forum_topic_list($tid, $topics, $sortby, $forum_per_page, $offset return $output; } -/** @} End of addtogroup themeable **/ +/** @} End of addtogroup themeable */ function _forum_icon($new_posts, $num_posts = 0, $comment_mode = 0) { diff --git a/modules/forum/forum.module b/modules/forum/forum.module index eaedf11e2..23c545f8a 100644 --- a/modules/forum/forum.module +++ b/modules/forum/forum.module @@ -459,23 +459,23 @@ function forum_page() { } /** - @addtogroup themeable - @{ -**/ + * @addtogroup themeable + * @{ + */ /** - Format the forum body. - - @param forums - @param topics - @param parents - @param tid - @param sortby - @param forum_per_page - @param offset - - @return the output for the forum body. -**/ + * Format the forum body. + * + * @param forums + * @param topics + * @param parents + * @param tid + * @param sortby + * @param forum_per_page + * @param offset + * + * @return the output for the forum body. + */ function theme_forum_display($forums, $topics, $parents, $tid, $sortby, $forum_per_page, $offset) { // forum list, topics list, topic browser and "add new topic" link @@ -519,14 +519,14 @@ function theme_forum_display($forums, $topics, $parents, $tid, $sortby, $forum_p } /** - Format the forum listing. - - @param forums - @param parents - @param tid - - @return output for the forum listing. -**/ + * Format the forum listing. + * + * @param forums + * @param parents + * @param tid + * + * @return output for the forum listing. + */ function theme_forum_list($forums, $parents, $tid) { global $user; @@ -582,16 +582,16 @@ function theme_forum_list($forums, $parents, $tid) { } /** - Format the topic listing. - - @param tid - @param topics - @param sortby - @param forum_per_page - @param offset - - @return output for the topic list. -**/ + * Format the topic listing. + * + * @param tid + * @param topics + * @param sortby + * @param forum_per_page + * @param offset + * + * @return output for the topic list. + */ function theme_forum_topic_list($tid, $topics, $sortby, $forum_per_page, $offset) { global $id, $status, $user, $pager_total, $forum_topic_list_header; @@ -632,7 +632,7 @@ function theme_forum_topic_list($tid, $topics, $sortby, $forum_per_page, $offset return $output; } -/** @} End of addtogroup themeable **/ +/** @} End of addtogroup themeable */ function _forum_icon($new_posts, $num_posts = 0, $comment_mode = 0) { diff --git a/modules/node.module b/modules/node.module index 97adb01cf..e02546b1c 100644 --- a/modules/node.module +++ b/modules/node.module @@ -112,11 +112,13 @@ function node_last_viewed($nid) { } /** - * Determines whether the supplied timestamp is newer than the user's last view of a given node + * Determines whether the supplied timestamp is newer than the user's last view + * of a given node * - * @param $nid node-id twhose history supplies the 'last viewed' timestamp - * @param $timestamp time which is compared against node's 'last veiwed' timestamp -*/ + * @param $nid node-id twhose history supplies the 'last viewed' timestamp + * @param $timestamp time which is compared against node's 'last veiwed' + * timestamp + */ function node_is_new($nid, $timestamp) { global $user; static $cache; diff --git a/modules/node/node.module b/modules/node/node.module index 97adb01cf..e02546b1c 100644 --- a/modules/node/node.module +++ b/modules/node/node.module @@ -112,11 +112,13 @@ function node_last_viewed($nid) { } /** - * Determines whether the supplied timestamp is newer than the user's last view of a given node + * Determines whether the supplied timestamp is newer than the user's last view + * of a given node * - * @param $nid node-id twhose history supplies the 'last viewed' timestamp - * @param $timestamp time which is compared against node's 'last veiwed' timestamp -*/ + * @param $nid node-id twhose history supplies the 'last viewed' timestamp + * @param $timestamp time which is compared against node's 'last veiwed' + * timestamp + */ function node_is_new($nid, $timestamp) { global $user; static $cache; diff --git a/modules/search.module b/modules/search.module index efb5876c1..f55f7eef3 100644 --- a/modules/search.module +++ b/modules/search.module @@ -32,7 +32,7 @@ function search_perm() { /** * Return an array of links to be displayed * - * @param $type The type of page requesting the link + * @param $type The type of page requesting the link * */ function search_link($type) { @@ -99,11 +99,11 @@ function search_cron() { * * 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 <i>module</i>_search of type + * array("keys" => ..., "type" => ..., "select" => ...) + * @see node_search for an explanation of array items * - * @return array of search results, each element being an array indexed with + * @return array of search results, each element being an array indexed with * "count", "title", "link", "user" (name), "date", "keywords" */ function do_search($search_array) { @@ -216,9 +216,9 @@ function do_search($search_array) { /** * Update the search_index table * - * @param $search_array an array as returned from <i>module</i>_update_index + * @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 + * @see node_update_index for an explanation of array items */ function update_index($search_array) { $last_update = variable_get($search_array["last_update"], 1); @@ -327,8 +327,8 @@ function search_invalidate() { /** * Save the values entered by the administrator for the search module * - * @param $edit An array of fields as setup via calling form_textfield, - * form_textarea etc + * @param $edit An array of fields as setup via calling form_textfield, + * form_textarea etc */ function search_save($edit) { variable_set("minimum_word_size", $edit["minimum_word_size"]); diff --git a/modules/search/search.module b/modules/search/search.module index efb5876c1..f55f7eef3 100644 --- a/modules/search/search.module +++ b/modules/search/search.module @@ -32,7 +32,7 @@ function search_perm() { /** * Return an array of links to be displayed * - * @param $type The type of page requesting the link + * @param $type The type of page requesting the link * */ function search_link($type) { @@ -99,11 +99,11 @@ function search_cron() { * * 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 <i>module</i>_search of type + * array("keys" => ..., "type" => ..., "select" => ...) + * @see node_search for an explanation of array items * - * @return array of search results, each element being an array indexed with + * @return array of search results, each element being an array indexed with * "count", "title", "link", "user" (name), "date", "keywords" */ function do_search($search_array) { @@ -216,9 +216,9 @@ function do_search($search_array) { /** * Update the search_index table * - * @param $search_array an array as returned from <i>module</i>_update_index + * @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 + * @see node_update_index for an explanation of array items */ function update_index($search_array) { $last_update = variable_get($search_array["last_update"], 1); @@ -327,8 +327,8 @@ function search_invalidate() { /** * Save the values entered by the administrator for the search module * - * @param $edit An array of fields as setup via calling form_textfield, - * form_textarea etc + * @param $edit An array of fields as setup via calling form_textfield, + * form_textarea etc */ function search_save($edit) { variable_set("minimum_word_size", $edit["minimum_word_size"]); diff --git a/modules/taxonomy.module b/modules/taxonomy.module index 74a1848c9..6274798b1 100644 --- a/modules/taxonomy.module +++ b/modules/taxonomy.module @@ -540,12 +540,11 @@ function _taxonomy_term_children($tid) { } /** - * Try to map a string to existing vocabularies. - * Provide case insensitive and trimmed map so as to - * maximize likelihood of successful mapping. + * Try to map a string to existing vocabularies. Provide case insensitive and + * trimmed map so as to maximize likelihood of successful mapping. * - * @param $name Name of the vocabulary to search - * @return 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 @@ -559,12 +558,11 @@ function taxonomy_get_vocabulary_by_name($name) { } /** - * Try to map a string to existing terms - * Provide case insensitive and trimmed map so as to - * maximize likelihood of successful mapping. + * Try to map a string to existing terms Provide case insensitive and trimmed + * map so as to maximize likelihood of successful mapping. * - * @param name Name of the term to search - * @return rray 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 74a1848c9..6274798b1 100644 --- a/modules/taxonomy/taxonomy.module +++ b/modules/taxonomy/taxonomy.module @@ -540,12 +540,11 @@ function _taxonomy_term_children($tid) { } /** - * Try to map a string to existing vocabularies. - * Provide case insensitive and trimmed map so as to - * maximize likelihood of successful mapping. + * Try to map a string to existing vocabularies. Provide case insensitive and + * trimmed map so as to maximize likelihood of successful mapping. * - * @param $name Name of the vocabulary to search - * @return 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 @@ -559,12 +558,11 @@ function taxonomy_get_vocabulary_by_name($name) { } /** - * Try to map a string to existing terms - * Provide case insensitive and trimmed map so as to - * maximize likelihood of successful mapping. + * Try to map a string to existing terms Provide case insensitive and trimmed + * map so as to maximize likelihood of successful mapping. * - * @param name Name of the term to search - * @return rray 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 |