add: documentation to output classes

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

diff --git a/src/org/cacert/gigi/output/template/OutputableArrayIterable.java b/src/org/cacert/gigi/output/template/OutputableArrayIterable.java
index 5a78e73bfa56a40eae55f9ef07287c4b9816e408..498954074de111f942da3cf97b9b8a7bf5f0d8cd 100644 (file)
--- a/src/org/cacert/gigi/output/template/OutputableArrayIterable.java
+++ b/src/org/cacert/gigi/output/template/OutputableArrayIterable.java
@@ -4,14 +4,26 @@ import java.util.Map;
 
 import org.cacert.gigi.localisation.Language;
 
+/**
+ * Generic implementation of {@link IterableDataset} that is fed by an array.
+ */
 public class OutputableArrayIterable implements IterableDataset {
 
-    Object[] content;
+    private Object[] content;
 
-    String targetName;
+    private String targetName;
 
-    int index = 0;
+    private int index = 0;
 
+    /**
+     * Creates a new {@link OutputableArrayIterable}.
+     * 
+     * @param content
+     *            the objects to be iterated over.
+     * @param targetName
+     *            the variable where the contents of the array to be put in the
+     *            loop.
+     */
     public OutputableArrayIterable(Object[] content, String targetName) {
         this.content = content;
         this.targetName = targetName;