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 908a0377ad419e70caf594ee4fbe3d343578f27b..5dce3aed211c1c45452d96929e6e0c3c9484dabe 100644 (file)
--- a/src/org/cacert/gigi/output/template/OutputVariableCommand.java
+++ b/src/org/cacert/gigi/output/template/OutputVariableCommand.java
@@ -6,12 +6,22 @@ import java.util.Map;
 
 import org.cacert.gigi.localisation.Language;
 
+/**
+ * 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;