Improve PHP doc comments.

This commit is contained in:
tjhunt
2007-12-12 19:02:01 +00:00
parent 4e0af3b107
commit a488df2a95
+7 -3
View File
@@ -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])) {