diff --git a/mod/forum/search.php b/mod/forum/search.php index c7cc504d2f8..3c8db0da9b6 100644 --- a/mod/forum/search.php +++ b/mod/forum/search.php @@ -296,10 +296,12 @@ echo $OUTPUT->paging_bar($totalcount, $page, $perpage, $url); echo $OUTPUT->footer(); - -/** - * @todo Document this function - */ + /** + * Print a full-sized search form for the specified course. + * + * @param object $course The Course that will be searched. + * @return void The function prints the form. + */ function forum_print_big_search_form($course) { global $CFG, $DB, $words, $subject, $phrase, $user, $userid, $fullwords, $notwords, $datefrom, $dateto, $PAGE, $OUTPUT; @@ -421,12 +423,13 @@ function forum_print_big_search_form($course) { /** * This function takes each word out of the search string, makes sure they are at least - * two characters long and returns an array containing every good word. + * two characters long and returns an string of the space-separated search + * terms. * - * @param string $words String containing space-separated strings to search for - * @param string $prefix String to prepend to the each token taken out of $words - * @returns array - * @todo Take the hardcoded limit out of this function and put it into a user-specified parameter + * @param string $words String containing space-separated strings to search for. + * @param string $prefix String to prepend to the each token taken out of $words. + * @return string The filtered search terms, separated by spaces. + * @todo Take the hardcoded limit out of this function and put it into a user-specified parameter. */ function forum_clean_search_terms($words, $prefix='') { $searchterms = explode(' ', $words); @@ -440,15 +443,16 @@ function forum_clean_search_terms($words, $prefix='') { return trim(implode(' ', $searchterms)); } -/** - * @todo Document this function - */ + /** + * Retrieve a list of the forums that this user can view. + * + * @param object $course The Course to use. + * @return array A set of formatted forum names stored against the forum id. + */ function forum_menu_list($course) { - $menu = array(); $modinfo = get_fast_modinfo($course); - if (empty($modinfo->instances['forum'])) { return $menu; } @@ -466,4 +470,3 @@ function forum_menu_list($course) { return $menu; } -