add: documentation to output classes

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

diff --git a/src/org/cacert/gigi/output/template/Outputable.java b/src/org/cacert/gigi/output/template/Outputable.java
index 5716162a8c5e32b07aec3cb948c7e425bdfc3e32..02fea41193086bf4c2af3fa1a1ab5dbdbe644208 100644 (file)
--- a/src/org/cacert/gigi/output/template/Outputable.java
+++ b/src/org/cacert/gigi/output/template/Outputable.java
@@ -5,7 +5,20 @@ import java.util.Map;
 
 import org.cacert.gigi.localisation.Language;
 
+/**
+ * An object that is outputable to the user normally in an HTML-page.
+ */
 public interface Outputable {
 
+    /**
+     * Writes this object's content to the given output stream.
+     * 
+     * @param out
+     *            the PrintWriter to the user.
+     * @param l
+     *            the {@link Language} to translate localizable strings to.
+     * @param vars
+     *            a map of variable assignments for this template.
+     */
     public void output(PrintWriter out, Language l, Map<String, Object> vars);
 }