From: tjhunt <tjhunt>
Date: Wed, 12 Dec 2007 19:01:59 +0000 (+0000)
Subject: Improve PHP doc comments.
X-Git-Url: http://git.mjollnir.org/gw?a=commitdiff_plain;h=901e25d48195e38e43499a648dd688d1d280294a;p=moodle.git

Improve PHP doc comments.
---

diff --git a/lib/tablelib.php b/lib/tablelib.php
index 4fd85b7b58..01c881fdb5 100644
--- a/lib/tablelib.php
+++ b/lib/tablelib.php
@@ -153,9 +153,13 @@ class flexible_table {
     }
 
     /**
-     * Sets the given $column index to true in $this->column_suppress.
-     * @param integer $column
-     * @return void
+     * I think that what this method does is set the column so that if the same data appears in 
+     * consecutive rows, then it is not repeated.
+     * 
+     * For example, in the quiz overview report, the fullname column is set to be suppressed, so
+     * that when one student has made multiple attempts, their name is only printed in the row
+     * for their first attempt.
+     * @param integer $column the index of a column.
      */
     function column_suppress($column) {
         if(isset($this->column_suppress[$column])) {