add: documentation to output classes

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

diff --git a/src/org/cacert/gigi/output/template/OutputVariableCommand.java b/src/org/cacert/gigi/output/template/OutputVariableCommand.java
index b3534edca8159a022f2824b9073d42f51fb4da1b..5dce3aed211c1c45452d96929e6e0c3c9484dabe 100644 (file)
--- a/src/org/cacert/gigi/output/template/OutputVariableCommand.java
+++ b/src/org/cacert/gigi/output/template/OutputVariableCommand.java
@@ -1,16 +1,27 @@
 package org.cacert.gigi.output.template;
 
 import java.io.PrintWriter;
+import java.util.Collection;
 import java.util.Map;
 
 import org.cacert.gigi.localisation.Language;
 
-public final class OutputVariableCommand implements Outputable {
+/**
+ * Emits a variable.
+ */
+public final class OutputVariableCommand implements Translatable {
 
     private final String raw;
 
     private final boolean unescaped;
 
+    /**
+     * Creates a new OutputVariableCommand.
+     * 
+     * @param raw
+     *            the variable to emit. If starting with <code>!</code> the
+     *            variable is emitted non-HTML-escaped.
+     */
     public OutputVariableCommand(String raw) {
         if (raw.charAt(0) == '!') {
             unescaped = true;
@@ -25,4 +36,7 @@ public final class OutputVariableCommand implements Outputable {
     public void output(PrintWriter out, Language l, Map<String, Object> vars) {
         Template.outputVar(out, l, vars, raw, unescaped);
     }
+
+    @Override
+    public void addTranslations(Collection<String> s) {}
 }