X-Git-Url: http://git.polytechnique.org/?a=blobdiff_plain;f=classes%2Fpliterator.php;h=c5807206608b47658eae80c7b3bafe48cda5824b;hb=7c44b8bc211c768efdb3be75c5a7057bf0e5663e;hp=0b5f25489e299938eeb189cb3eedf1993534dc01;hpb=ba63661ce2f38974002c7e4113320e9d06010853;p=platal.git

diff --git a/classes/pliterator.php b/classes/pliterator.php
index 0b5f254..c580720 100644
--- a/classes/pliterator.php
+++ b/classes/pliterator.php
@@ -1,6 +1,6 @@
 <?php
 /***************************************************************************
- *  Copyright (C) 2003-2008 Polytechnique.org                              *
+ *  Copyright (C) 2003-2010 Polytechnique.org                              *
  *  http://opensource.polytechnique.org/                                   *
  *                                                                         *
  *  This program is free software; you can redistribute it and/or modify   *
@@ -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();
 }