From 341ed1dbc2f8cc8cedb50b12914aa113d12958ee Mon Sep 17 00:00:00 2001 From: =?utf8?q?Felix=20D=C3=B6rre?= Date: Thu, 2 Jun 2016 09:25:16 +0200 Subject: [PATCH] upd: Normalize tailing dots in "output.template"-Documentation ... and fix a typo Change-Id: Id86b8b6e448d5a9401caf6053adb5ef337db180d --- src/org/cacert/gigi/output/template/Form.java | 12 ++++++------ src/org/cacert/gigi/output/template/IfStatement.java | 6 +++--- .../cacert/gigi/output/template/IterableDataset.java | 2 +- src/org/cacert/gigi/output/template/Scope.java | 2 +- .../cacert/gigi/output/template/SprintfCommand.java | 6 +++--- 5 files changed, 14 insertions(+), 14 deletions(-) diff --git a/src/org/cacert/gigi/output/template/Form.java b/src/org/cacert/gigi/output/template/Form.java index 366d31c5..83a96f38 100644 --- 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 f2248bcc..1b49f3b2 100644 --- 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 8c96727b..26405a54 100644 --- 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 38e25ebc..700ccfe7 100644 --- 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 cbd79e57..006155d2 100644 --- 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 {0},{1},.. 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 scope = new HashMap<>(); -- 2.39.2