add: documentation to output classes

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

diff --git a/src/org/cacert/gigi/output/template/TranslateCommand.java b/src/org/cacert/gigi/output/template/TranslateCommand.java
index 9da43524c6b6a67b6e7bb659ac726dde8b44d9e2..d291e9d414b3d4ce0111b3edf1c1ff85963b9294 100644 (file)
--- a/src/org/cacert/gigi/output/template/TranslateCommand.java
+++ b/src/org/cacert/gigi/output/template/TranslateCommand.java
@@ -7,10 +7,19 @@ import java.util.Map;
 import org.cacert.gigi.localisation.Language;
 import org.cacert.gigi.util.HTMLEncoder;
 
+/**
+ * Wraps a String that needs to be translated before it is printed to the user.
+ */
 public final class TranslateCommand implements Translatable {
 
     private final String raw;
 
+    /**
+     * Creates a new TranslateCommand that wraps the given String.
+     * 
+     * @param raw
+     *            the String to be translated.
+     */
     public TranslateCommand(String raw) {
         this.raw = raw;
     }
@@ -20,6 +29,11 @@ public final class TranslateCommand implements Translatable {
         out.print(HTMLEncoder.encodeHTML(l.getTranslation(raw)));
     }
 
+    /**
+     * Gets the raw, untranslated String.
+     * 
+     * @return the raw, untranslated String.
+     */
     public String getRaw() {
         return raw;
     }