mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-02-13 12:34:28 +01:00
Code Issues Projects Releases Wiki Activity

Added a few more comments

Browse Source
This commit is contained in:
nicolasconnault 2007-04-12 05:59:09 +00:00
parent 1f11c89751
commit 1670305df4
1 changed files with 27 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
mod/forum/lib.php
View File

@ -743,7 +743,16 @@ function forum_cron() {
}
/**
* TODO document
* Builds and returns the body of the email notification in plain text.
*
* @param object $course
* @param object $forum
* @param object $discussion
* @param object $post
* @param object $userfrom
* @param object $userto
* @param boolean $bare
* @return string The email body in plain text format.
*/
function forum_make_mail_text($course, $forum, $discussion, $post, $userfrom, $userto, $bare = false) {
global $CFG, $USER;
@ -804,7 +813,15 @@ function forum_make_mail_text($course, $forum, $discussion, $post, $userfrom, $u
}
/**
* TODO document
* Builds and returns the body of the email notification in html format.
*
* @param object $course
* @param object $forum
* @param object $discussion
* @param object $post
* @param object $userfrom
* @param object $userto
* @return string The email text in HTML format
*/
function forum_make_mail_html($course, $forum, $discussion, $post, $userfrom, $userto) {
global $CFG;
@ -845,8 +862,15 @@ function forum_make_mail_html($course, $forum, $discussion, $post, $userfrom, $u
return $posthtml;
}
/**
* TODO document
*
* @param object $course
* @param object $user
* @param object $mod TODO this is not used in this function, refactor
* @param object $forum
* @return object A standard object with 2 variables: info (number of posts for this user) and time (last modified)
*/
function forum_user_outline($course, $user, $mod, $forum) {