upd: Normalize tailing dots in "output.template"-Documentation

... and fix a typo

Change-Id: Id86b8b6e448d5a9401caf6053adb5ef337db180d

diff --git a/src/org/cacert/gigi/output/template/Form.java b/src/org/cacert/gigi/output/template/Form.java
index 366d31c5913684a032eaf5b379996978a48673bd..83a96f3813ad6bdb0c20bbc817f73f5eb2287b35 100644 (file)
--- a/src/org/cacert/gigi/output/template/Form.java
+++ b/src/org/cacert/gigi/output/template/Form.java
@@ -40,7 +40,7 @@ public abstract class Form implements Outputable {
      * @param hsr
      *            the request to register the form against.
      * @param action
-     *            the target path where the form should be submitted
+     *            the target path where the form should be submitted.
      */
     public Form(HttpServletRequest hsr, String action) {
         csrf = RandomToken.generateToken(32);
@@ -55,8 +55,8 @@ public abstract class Form implements Outputable {
      * @param out
      *            the stream to the user.
      * @param req
-     *            the request to take the initial data from
-     * @return true, iff the form succeeded an the user should be redirected.
+     *            the request to take the initial data from.
+     * @return true, iff the form succeeded and the user should be redirected.
      * @throws GigiApiException
      *             if internal operations went wrong.
      */
@@ -84,9 +84,9 @@ public abstract class Form implements Outputable {
      * Outputs the forms contents.
      * 
      * @param out
-     *            Stream to the user
+     *            Stream to the user.
      * @param l
-     *            {@link Language} to translate text to
+     *            {@link Language} to translate text to.
      * @param vars
      *            Variables supplied from the outside.
      */
@@ -135,7 +135,7 @@ public abstract class Form implements Outputable {
      * @param req
      *            the request that is directed to the form.
      * @param target
-     *            the {@link Class} of the expected form
+     *            the {@link Class} of the expected form.
      * @return the form where this request is directed to.
      * @throws CSRFException
      *             if no CSRF-token is found or the token is wrong.

diff --git a/src/org/cacert/gigi/output/template/IfStatement.java b/src/org/cacert/gigi/output/template/IfStatement.java
index f2248bcc72fd3a3987b87cc22f7192d5c2883bdc..1b49f3b28f0ae1dad5dfe8526cbd5e347cd9b9e6 100644 (file)
--- a/src/org/cacert/gigi/output/template/IfStatement.java
+++ b/src/org/cacert/gigi/output/template/IfStatement.java
@@ -22,7 +22,7 @@ public final class IfStatement implements Translatable {
      * Creates a new {@link IfStatement} with an empty else-part.
      * 
      * @param variable
-     *            the variable to check
+     *            the variable to check.
      * @param body
      *            the body to emit conditionally.
      */
@@ -36,11 +36,11 @@ public final class IfStatement implements Translatable {
      * Creates a new {@link IfStatement} with an else-block.
      * 
      * @param variable
-     *            the variable to check
+     *            the variable to check.
      * @param iftrue
      *            the block to emit if the check succeeds.
      * @param iffalse
-     *            the block to emit if the check fails
+     *            the block to emit if the check fails.
      */
     public IfStatement(String variable, TemplateBlock iftrue, TemplateBlock iffalse) {
         this.variable = variable;

diff --git a/src/org/cacert/gigi/output/template/IterableDataset.java b/src/org/cacert/gigi/output/template/IterableDataset.java
index 8c96727b48f2459067bebb840d45fab56979ff61..26405a54cb4c998cca1b331bb0d9fe9147b15fa9 100644 (file)
--- a/src/org/cacert/gigi/output/template/IterableDataset.java
+++ b/src/org/cacert/gigi/output/template/IterableDataset.java
@@ -14,7 +14,7 @@ public interface IterableDataset {
      * Moves to the next Dataset.
      * 
      * @param l
-     *            the language for l10n-ed strings
+     *            the language for l10n-ed strings.
      * @param vars
      *            the variables used in this template. They need to be updated
      *            for each line.

diff --git a/src/org/cacert/gigi/output/template/Scope.java b/src/org/cacert/gigi/output/template/Scope.java
index 38e25ebc5809f5dfe7e78662e005fbe41c20d7b4..700ccfe7e9b717229869720ebc61f3eb387a5a41 100644 (file)
--- a/src/org/cacert/gigi/output/template/Scope.java
+++ b/src/org/cacert/gigi/output/template/Scope.java
@@ -20,7 +20,7 @@ public class Scope implements Outputable {
      * Creates a new {@link Scope}.
      * 
      * @param out
-     *            the enclosed {@link Outputable}
+     *            the enclosed {@link Outputable}.
      * @param vars
      *            the variables to assign in the inner scope.
      */

diff --git a/src/org/cacert/gigi/output/template/SprintfCommand.java b/src/org/cacert/gigi/output/template/SprintfCommand.java
index cbd79e57a14ebfface943921c8b1b0765d568406..006155d2ffdd6f12836aa639506cff4e423a0407 100644 (file)
--- a/src/org/cacert/gigi/output/template/SprintfCommand.java
+++ b/src/org/cacert/gigi/output/template/SprintfCommand.java
@@ -23,7 +23,7 @@ public final class SprintfCommand implements Translatable {
     private final String[] store;
 
     /**
-     * Creates a new SprintfCommand based on its pre-parsed contents
+     * Creates a new SprintfCommand based on its pre-parsed contents.
      * 
      * @param text
      *            a string with <code>{0},{1},..</code> as placeholders.
@@ -44,7 +44,7 @@ public final class SprintfCommand implements Translatable {
      * Creates a new SprintfCommand that is parsed as from template source.
      * 
      * @param content
-     *            the part from the template that is to be parsed
+     *            the part from the template that is to be parsed.
      */
     protected SprintfCommand(String content) {
         StringBuffer raw = new StringBuffer();
@@ -109,7 +109,7 @@ public final class SprintfCommand implements Translatable {
      *            as placeholders.
      * @param vars
      *            the variables to put into the placeholders.
-     * @return the constructed {@link Outputable}
+     * @return the constructed {@link Outputable}.
      */
     public static Outputable createSimple(String msg, String... vars) {
         HashMap<String, Object> scope = new HashMap<>();