From d715f651f4797923472f3a5e9e90d3cb06b49aa9 Mon Sep 17 00:00:00 2001
From: mchurch <mchurch>
Date: Thu, 19 Jul 2007 17:01:04 +0000
Subject: [PATCH] Changing the doc.

---
 mod/assignment/lib.php | 17 +++++++++++------
 1 file changed, 11 insertions(+), 6 deletions(-)

diff --git a/mod/assignment/lib.php b/mod/assignment/lib.php
index 27c04221b36..bd133543aa1 100644
--- a/mod/assignment/lib.php
+++ b/mod/assignment/lib.php
@@ -2306,12 +2306,17 @@ 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
-///
+/**
+ * Add a get_coursemodule_info function in case any assignment type wants to add 'extra' information
+ * for the course (see resource).
+ *
+ * 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).
+ * @return object An object on information that the coures will know about (most noticeably, an icon).
+ * 
+ */
 function assignment_get_coursemodule_info($coursemodule) {
     global $CFG;