add: documentation to output classes

[gigi.git] / src / org / cacert / gigi / output / template / IterableDataset.java

diff --git a/src/org/cacert/gigi/output/template/IterableDataset.java b/src/org/cacert/gigi/output/template/IterableDataset.java
index bd7b99b25b3d5cf9a975b7e92e924dfac18e11eb..8c96727b48f2459067bebb840d45fab56979ff61 100644 (file)
--- a/src/org/cacert/gigi/output/template/IterableDataset.java
+++ b/src/org/cacert/gigi/output/template/IterableDataset.java
@@ -2,22 +2,24 @@ package org.cacert.gigi.output.template;
 
 import java.util.Map;
 
-import org.cacert.gigi.Language;
+import org.cacert.gigi.localisation.Language;
 
 /**
- * Represents some kind of data, that may be iterated over in a template.
+ * Represents some kind of data, that may be iterated over in a template using
+ * the <code>foreach</code> statement.
  */
 public interface IterableDataset {
-       /**
-        * Moves to the next Dataset.
-        * 
-        * @param l
-        *            the language for l10n-ed strings
-        * @param vars
-        *            the variables used in this template. They need to be updated
-        *            for each line.
-        * @return true, iff there was a data-line "installed". False of this set is
-        *         already empty.
-        */
-       public boolean next(Language l, Map<String, Object> vars);
+
+    /**
+     * Moves to the next Dataset.
+     * 
+     * @param l
+     *            the language for l10n-ed strings
+     * @param vars
+     *            the variables used in this template. They need to be updated
+     *            for each line.
+     * @return true, iff there was a data-line "installed". False of this set is
+     *         already empty.
+     */
+    public boolean next(Language l, Map<String, Object> vars);
 }