add: documentation to output classes

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

diff --git a/src/org/cacert/gigi/output/template/IfStatement.java b/src/org/cacert/gigi/output/template/IfStatement.java
index 29cfc768f2ac674706a367325ef5eb6aa90b6dea..f2248bcc72fd3a3987b87cc22f7192d5c2883bdc 100644 (file)
--- a/src/org/cacert/gigi/output/template/IfStatement.java
+++ b/src/org/cacert/gigi/output/template/IfStatement.java
@@ -6,6 +6,10 @@ import java.util.Map;
 
 import org.cacert.gigi.localisation.Language;
 
+/**
+ * One ore two {@link Outputable}s that are emitted conditionally if a given
+ * variable is neither <code>null</code> nor {@link Boolean#FALSE}.
+ */
 public final class IfStatement implements Translatable {
 
     private final String variable;
@@ -14,12 +18,30 @@ public final class IfStatement implements Translatable {
 
     private final TemplateBlock iffalse;
 
+    /**
+     * Creates a new {@link IfStatement} with an empty else-part.
+     * 
+     * @param variable
+     *            the variable to check
+     * @param body
+     *            the body to emit conditionally.
+     */
     public IfStatement(String variable, TemplateBlock body) {
         this.variable = variable;
         this.iftrue = body;
         this.iffalse = null;
     }
 
+    /**
+     * Creates a new {@link IfStatement} with an else-block.
+     * 
+     * @param variable
+     *            the variable to check
+     * @param iftrue
+     *            the block to emit if the check succeeds.
+     * @param iffalse
+     *            the block to emit if the check fails
+     */
     public IfStatement(String variable, TemplateBlock iftrue, TemplateBlock iffalse) {
         this.variable = variable;
         this.iftrue = iftrue;