More tools around PlIterator:

[platal.git] / classes / pliterator.php

diff --git a/classes/pliterator.php b/classes/pliterator.php
index 0b5f254..47f809f 100644 (file)
--- a/classes/pliterator.php
+++ b/classes/pliterator.php
@@ -19,11 +19,25 @@
  *  59 Temple Place, Suite 330, Boston, MA  02111-1307  USA                *
  ***************************************************************************/
 
+/** An iterator.
+ */
 interface PlIterator
 {
+    /** Fetch and return the next element of the iterator.
+     * If no more element is available, return null.
+     */
     public function next();
+
+    /** Return the number of element of the iterator.
+     */
     public function total();
+
+    /** True if the current element is the first element.
+     */
     public function first();
+
+    /** True if the current element is the last element.
+     */
     public function last();
 }