add: documentation to output classes

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

diff --git a/src/org/cacert/gigi/output/template/ForeachStatement.java b/src/org/cacert/gigi/output/template/ForeachStatement.java
index 8c12122be098374ecb376b69b2e8aae876676191..4c8b1027b5f7dfb3df420b309fffe699fad94d26 100644 (file)
--- a/src/org/cacert/gigi/output/template/ForeachStatement.java
+++ b/src/org/cacert/gigi/output/template/ForeachStatement.java
@@ -7,12 +7,24 @@ import java.util.Map;
 
 import org.cacert.gigi.localisation.Language;
 
+/**
+ * Outputs an {@link Outputable} multiple times based on a given
+ * {@link IterableDataset}.
+ */
 public final class ForeachStatement implements Translatable {
 
     private final String variable;
 
     private final TemplateBlock body;
 
+    /**
+     * Creates a new {@link ForeachStatement}.
+     * 
+     * @param variable
+     *            the variable to take the {@link IterableDataset} from.
+     * @param body
+     *            the body to output multiple times.
+     */
     public ForeachStatement(String variable, TemplateBlock body) {
         this.variable = variable;
         this.body = body;