X-Git-Url: http://git.polytechnique.org/?a=blobdiff_plain;f=classes%2Fpliterator.php;h=3c98eb8aeb76e16b4e054ca232876642fb573a82;hb=0d78a96bb5914bcbe0dd08a6a237134daebbaffe;hp=0b5f25489e299938eeb189cb3eedf1993534dc01;hpb=dd9bac8f7903e9924525ad8db3e38650ff5ad1b6;p=platal.git

diff --git a/classes/pliterator.php b/classes/pliterator.php
index 0b5f254..3c98eb8 100644
--- a/classes/pliterator.php
+++ b/classes/pliterator.php
@@ -1,6 +1,6 @@
 <?php
 /***************************************************************************
- *  Copyright (C) 2003-2008 Polytechnique.org                              *
+ *  Copyright (C) 2003-2009 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();
 }