MDL-40867 fix misleading PHPdocs for _get_coursemodule_info

moodle · Jul 26, 2013 · 205a3cd · 205a3cd
1 parent cd08b5c
commit 205a3cd
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 5 deletions.
diff --git a/mod/assignment/lib.php b/mod/assignment/lib.php
@@ -3595,7 +3595,7 @@ function assignment_get_all_submissions($assignment, $sort="", $dir="DESC") {
  * Given a course_module object, this function returns any "extra" information that may be needed
  * when printing this activity in a course listing.  See get_array_of_activities() in course/lib.php.
  *
- * @param $coursemodule object The coursemodule object (record).
+ * @param stdClass $coursemodule object The coursemodule object (record).
  * @return cached_cm_info An object on information that the courses will know about (most noticeably, an icon).
  */
 function assignment_get_coursemodule_info($coursemodule) {

diff --git a/mod/label/lib.php b/mod/label/lib.php
@@ -118,7 +118,7 @@ function label_delete_instance($id) {
  *
  * @global object
  * @param object $coursemodule
- * @return object|null
+ * @return cached_cm_info|null
  */
 function label_get_coursemodule_info($coursemodule) {
     global $DB;

diff --git a/mod/page/lib.php b/mod/page/lib.php
@@ -238,7 +238,7 @@ function page_user_complete($course, $user, $mod, $page) {
  *
  * See {@link get_array_of_activities()} in course/lib.php
  *
- * @param cm_info $coursemodule
+ * @param stdClass $coursemodule
  * @return cached_cm_info Info to customise main page display
  */
 function page_get_coursemodule_info($coursemodule) {

diff --git a/mod/resource/lib.php b/mod/resource/lib.php
@@ -225,7 +225,7 @@ function resource_user_complete($course, $user, $mod, $resource) {
  *
  * See {@link get_array_of_activities()} in course/lib.php
  *
- * @param cm_info $coursemodule
+ * @param stdClass $coursemodule
  * @return cached_cm_info info
  */
 function resource_get_coursemodule_info($coursemodule) {

diff --git a/mod/url/lib.php b/mod/url/lib.php
@@ -243,7 +243,7 @@ function url_user_complete($course, $user, $mod, $url) {
  * See {@link get_array_of_activities()} in course/lib.php
  *
  * @param object $coursemodule
- * @return object info
+ * @return cached_cm_info info
  */
 function url_get_coursemodule_info($coursemodule) {
     global $CFG, $DB;