add: documentation to output classes

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

diff --git a/src/org/cacert/gigi/output/template/Scope.java b/src/org/cacert/gigi/output/template/Scope.java
index 9a15b3a4c3ea8db8c218ff887d2d9aac80bdb322..38e25ebc5809f5dfe7e78662e005fbe41c20d7b4 100644 (file)
--- a/src/org/cacert/gigi/output/template/Scope.java
+++ b/src/org/cacert/gigi/output/template/Scope.java
@@ -6,12 +6,24 @@ import java.util.Map;
 
 import org.cacert.gigi.localisation.Language;
 
+/**
+ * Builds a variable scope around another {@link Outputable}, statically filling
+ * variables.
+ */
 public class Scope implements Outputable {
 
     private Map<String, Object> vars;
 
     private Outputable out;
 
+    /**
+     * Creates a new {@link Scope}.
+     * 
+     * @param out
+     *            the enclosed {@link Outputable}
+     * @param vars
+     *            the variables to assign in the inner scope.
+     */
     public Scope(Outputable out, Map<String, Object> vars) {
         this.out = out;
         this.vars = vars;