From 53454761ed4d619b328d7cb5f628daafe127efb7 Mon Sep 17 00:00:00 2001
From: Remi Collet <fedora@famillecollet.com>
Date: Tue, 8 Jun 2010 19:34:49 +0200
Subject: some docs

---
 class/CommonTable.php   |  1 +
 class/TableIterator.php | 30 +++++++++++++++---------------
 2 files changed, 16 insertions(+), 15 deletions(-)

(limited to 'class')

diff --git a/class/CommonTable.php b/class/CommonTable.php
index f08b29e..1102c4d 100644
--- a/class/CommonTable.php
+++ b/class/CommonTable.php
@@ -145,6 +145,7 @@ abstract class CommonTable
 
         return $nb;
     }
+
     /**
      * Create the table
      */
diff --git a/class/TableIterator.php b/class/TableIterator.php
index 9f5889b..5c42d24 100644
--- a/class/TableIterator.php
+++ b/class/TableIterator.php
@@ -52,7 +52,7 @@ class TableIterator  implements Iterator
      *
      * @param CommonDBTM   $dbconnexion Database Connnexion
      *                                  (must be a CommonDBTM object)
-     * @param string       $table       table name
+     * @param string       $table       table name or complete SQL request
      * @param string|array $crit        string or array of filed/values,
      *                                  ex array("id"=>1), if empty => all rows
      */
@@ -154,8 +154,8 @@ class TableIterator  implements Iterator
     /**
      * Build WHERE clause
      *
-     * @param TODO $crit To document
-     * @param TODO $bool To document
+     * @param string|array $crit To document
+     * @param string $bool logical operator between criteria
      *
      * @return To document
      */
@@ -208,9 +208,9 @@ class TableIterator  implements Iterator
     }
 
     /**
-    * To document
+     * Go to the begin of the request (launch it)
      *
-     * @return To document
+     * @return hastable|false : next row
     */
     public function rewind ()
     {
@@ -230,9 +230,9 @@ class TableIterator  implements Iterator
     }
 
     /**
-     * To document
+     * Retrieve current row
      *
-     * @return To document
+     * @return hastable|false
      */
     public function current()
     {
@@ -240,9 +240,9 @@ class TableIterator  implements Iterator
     }
 
     /**
-     * To document
+     * Retrieve key of current row
      *
-     * @return To document
+     * @return mixed
      */
     public function key()
     {
@@ -250,9 +250,9 @@ class TableIterator  implements Iterator
     }
 
     /**
-     * To document
+     * Retrieve next row
      *
-     * @return To document
+     * @return hastable|false
      */
     public function next()
     {
@@ -265,9 +265,9 @@ class TableIterator  implements Iterator
     }
 
     /**
-     * To document
+     * Is current row defined
      *
-     * @return To document
+     * @return boolean
      */
     public function valid()
     {
@@ -275,9 +275,9 @@ class TableIterator  implements Iterator
     }
 
     /**
-     * To document
+     * Compute number of rows
      *
-     * @return To document
+     * @return integer
      */
     public function numrows()
     {
-- 
cgit