mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-04-24 18:04:43 +02:00
Code Issues Projects Releases Wiki Activity

Improve PHP doc comments.

Browse Source
This commit is contained in:
tjhunt 2007-12-12 17:10:48 +00:00
parent 6967ba2846
commit 3d96cba76a
2 changed files with 11 additions and 4 deletions

14
lib/datalib.php

@ -1678,15 +1678,21 @@ function get_all_instances_in_courses($modulename, $courses, $userid=NULL, $incl
}
/**
* Returns an array of all the active instances of a particular module in a given course, sorted in the order they are defined
* Returns an array of all the active instances of a particular module in a given course,
* sorted in the order they are defined.
*
* Returns an array of all the active instances of a particular
* module in a given course, sorted in the order they are defined
* in the course. Returns false on any errors.
* in the course. Returns an empty array on any errors.
*
* The returned objects includle the columns cw.section, cm.visible,
* cm.groupmode and cm.groupingid, and are indexed by cm.id.
*
* @uses $CFG
* @param string $modulename The name of the module to get instances for
* @param object(course) $course This depends on an accurate $course->modinfo
* @param string $modulename The name of the module to get instances for
* @param object $course This depends on an accurate $course->modinfo
* @return array of module instance objects, including some extra fields from the course_modules
* and course_sections tables, or an empty array if an error occurred.
*/
function get_all_instances_in_course($modulename, $course, $userid=NULL, $includeinvisible=false) {

1
lib/grouplib.php

@ -258,6 +258,7 @@ function groups_get_course_groupmode($course) {
/**
* Returns effective groupmode used in activity, course setting
* overrides activity setting if groupmodeforce enabled.
* @param $cm the course module object. Only the ->course and ->groupmode need to be set.
* @return integer group mode
*/
function groups_get_activity_groupmode($cm) {