Fix some phpdocs
authorDan Marsden <dan@danmarsden.com>
Wed, 16 Mar 2016 02:29:21 +0000 (15:29 +1300)
committerDan Marsden <dan@danmarsden.com>
Wed, 16 Mar 2016 02:29:21 +0000 (15:29 +1300)
locallib.php

index 6ab5f5e..b13046a 100644 (file)
@@ -191,8 +191,9 @@ function attendance_get_user_courses_attendances($userid) {
 /**
  * Used to caclulate usergrade based on rawgrade and max grade.
  *
- * @param $grade - raw grade for user
- * @param $maxgrade - maxgrade for this session.
+ * @param float $grade - raw grade for user
+ * @param float $maxgrade - maxgrade for this session.
+ * @return float the calculated grade.
  */
 function attendance_calc_user_grade_fraction($grade, $maxgrade) {
     if ($maxgrade == 0) {
@@ -205,8 +206,9 @@ function attendance_calc_user_grade_fraction($grade, $maxgrade) {
 /**
  * Update all user grades - used when settings have changed.
  *
- * @param $attendance
- * @param $coursemodule
+ * @param mod_attendance_structure $attendance - Full attendance class.
+ * @param stdclass $coursemodule - full coursemodule record
+ * @return float the calculated grade.
  */
 function attendance_update_all_users_grades(mod_attendance_structure $attendance, $coursemodule) {
     $grades = array();