summaryrefslogtreecommitdiff
path: root/framework/Collections/TDummyDataSource.php
diff options
context:
space:
mode:
authorxue <>2006-01-20 01:33:13 +0000
committerxue <>2006-01-20 01:33:13 +0000
commit381d966198453626832c97447deb54f9cc4b06dd (patch)
tree68b8f846042648a04e504d7e24d7ecaa91453382 /framework/Collections/TDummyDataSource.php
parent17e24f69815019da609fb9975ab265c29c8a0af8 (diff)
Fixed documentation.
Diffstat (limited to 'framework/Collections/TDummyDataSource.php')
-rw-r--r--framework/Collections/TDummyDataSource.php14
1 files changed, 10 insertions, 4 deletions
diff --git a/framework/Collections/TDummyDataSource.php b/framework/Collections/TDummyDataSource.php
index 74f5f667..46e625ab 100644
--- a/framework/Collections/TDummyDataSource.php
+++ b/framework/Collections/TDummyDataSource.php
@@ -14,7 +14,8 @@
* TDummyDataSource class
*
* TDummyDataSource implements a dummy data collection with a specified number
- * of dummy data items. You can traverse it using <b>foreach</b>
+ * of dummy data items. The number of virtual items can be set via
+ * {@link setCount Count} property. You can traverse it using <b>foreach</b>
* PHP statement like the following,
* <code>
* foreach($dummyDataSource as $dataItem)
@@ -29,11 +30,18 @@ class TDummyDataSource extends TComponent implements IteratorAggregate
{
private $_count;
+ /**
+ * Constructor.
+ * @param integer number of (virtual) items in the data source.
+ */
public function __construct($count)
{
$this->_count=$count;
}
+ /**
+ * @return integer number of (virtual) items in the data source.
+ */
public function getCount()
{
return $this->_count;
@@ -69,9 +77,7 @@ class TDummyDataSourceIterator implements Iterator
/**
* Constructor.
- * @param TList the data to be iterated through
- * @param integer start index
- * @param integer number of items to be iterated through
+ * @param integer number of (virtual) items in the data source.
*/
public function __construct($count)
{