From f92c9e2b89d5d6632a5666891dc086bef6637c7f Mon Sep 17 00:00:00 2001 From: Rsl1122 Date: Tue, 18 Sep 2018 12:07:38 +0300 Subject: [PATCH] [Docs] Added javadoc titles for Formatter classes Affected issues: none --- .../plan/utilities/formatting/DecimalFormatter.java | 2 +- .../plan/utilities/formatting/EntityNameFormatter.java | 2 +- .../plan/utilities/formatting/ItemNameFormatter.java | 2 +- .../plan/utilities/formatting/PercentageFormatter.java | 2 +- .../plan/utilities/formatting/time/ClockFormatter.java | 2 +- .../plan/utilities/formatting/time/DateFormatter.java | 4 ++-- .../plan/utilities/formatting/time/DateHolderFormatter.java | 4 ++-- .../plan/utilities/formatting/time/DayFormatter.java | 2 +- .../utilities/formatting/time/ISO8601NoClockFormatter.java | 2 +- .../plan/utilities/formatting/time/SecondFormatter.java | 2 +- .../plan/utilities/formatting/time/YearFormatter.java | 2 +- 11 files changed, 13 insertions(+), 13 deletions(-) diff --git a/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/DecimalFormatter.java b/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/DecimalFormatter.java index d466abb42..f5d7e8286 100644 --- a/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/DecimalFormatter.java +++ b/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/DecimalFormatter.java @@ -6,7 +6,7 @@ import com.djrapitops.plan.system.settings.config.PlanConfig; import java.text.DecimalFormat; /** - * //TODO Class Javadoc Comment + * Formatter for decimal points that depends on settings. * * @author Rsl1122 */ diff --git a/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/EntityNameFormatter.java b/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/EntityNameFormatter.java index 02e37011e..20ea5daa1 100644 --- a/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/EntityNameFormatter.java +++ b/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/EntityNameFormatter.java @@ -3,7 +3,7 @@ package com.djrapitops.plan.utilities.formatting; import com.djrapitops.plugin.utilities.Format; /** - * //TODO Class Javadoc Comment + * Formatter for entity names, that capitalizes the first word and removes symbols and numbers. * * @author Rsl1122 */ diff --git a/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/ItemNameFormatter.java b/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/ItemNameFormatter.java index e93cd1272..4d39be4b7 100644 --- a/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/ItemNameFormatter.java +++ b/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/ItemNameFormatter.java @@ -6,7 +6,7 @@ import org.apache.commons.text.TextStringBuilder; import java.util.Arrays; /** - * //TODO Class Javadoc Comment + * Formatter for Item names, that capitalizes each part and separates them with spaces instead of underscores. * * @author Rsl1122 */ diff --git a/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/PercentageFormatter.java b/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/PercentageFormatter.java index 5e5e1a42a..cf68ea88a 100644 --- a/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/PercentageFormatter.java +++ b/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/PercentageFormatter.java @@ -1,7 +1,7 @@ package com.djrapitops.plan.utilities.formatting; /** - * //TODO Class Javadoc Comment + * Formatter for percentages. * * @author Rsl1122 */ diff --git a/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/time/ClockFormatter.java b/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/time/ClockFormatter.java index 2788a4921..8bf88b8e6 100644 --- a/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/time/ClockFormatter.java +++ b/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/time/ClockFormatter.java @@ -4,7 +4,7 @@ import com.djrapitops.plan.system.settings.Settings; import com.djrapitops.plan.system.settings.config.PlanConfig; /** - * //TODO Class Javadoc Comment + * Formatter for a timestamp that only includes a clock. * * @author Rsl1122 */ diff --git a/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/time/DateFormatter.java b/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/time/DateFormatter.java index 2d3cfed16..a19f605bd 100644 --- a/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/time/DateFormatter.java +++ b/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/time/DateFormatter.java @@ -1,8 +1,8 @@ package com.djrapitops.plan.utilities.formatting.time; -import com.djrapitops.plan.utilities.formatting.Formatter; import com.djrapitops.plan.system.settings.Settings; import com.djrapitops.plan.system.settings.config.PlanConfig; +import com.djrapitops.plan.utilities.formatting.Formatter; import com.djrapitops.plugin.api.TimeAmount; import java.text.SimpleDateFormat; @@ -10,7 +10,7 @@ import java.util.Locale; import java.util.TimeZone; /** - * //TODO Class Javadoc Comment + * Abstract formatter for a timestamp. * * @author Rsl1122 */ diff --git a/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/time/DateHolderFormatter.java b/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/time/DateHolderFormatter.java index 8909bd301..bc19e9d01 100644 --- a/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/time/DateHolderFormatter.java +++ b/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/time/DateHolderFormatter.java @@ -1,10 +1,10 @@ package com.djrapitops.plan.utilities.formatting.time; -import com.djrapitops.plan.utilities.formatting.Formatter; import com.djrapitops.plan.data.store.objects.DateHolder; +import com.djrapitops.plan.utilities.formatting.Formatter; /** - * //TODO Class Javadoc Comment + * Formatter for a DateHolder object that uses a different formatter. * * @author Rsl1122 */ diff --git a/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/time/DayFormatter.java b/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/time/DayFormatter.java index 31163c5ad..42afc290b 100644 --- a/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/time/DayFormatter.java +++ b/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/time/DayFormatter.java @@ -4,7 +4,7 @@ import com.djrapitops.plan.system.settings.Settings; import com.djrapitops.plan.system.settings.config.PlanConfig; /** - * //TODO Class Javadoc Comment + * Formatter for a timestamp which includes days as the smallest entry. * * @author Rsl1122 */ diff --git a/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/time/ISO8601NoClockFormatter.java b/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/time/ISO8601NoClockFormatter.java index b4aab4d56..90dd7c8b8 100644 --- a/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/time/ISO8601NoClockFormatter.java +++ b/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/time/ISO8601NoClockFormatter.java @@ -3,7 +3,7 @@ package com.djrapitops.plan.utilities.formatting.time; import com.djrapitops.plan.system.settings.config.PlanConfig; /** - * //TODO Class Javadoc Comment + * Formatter for a timestamp in ISO-8601 format without the clock. * * @author Rsl1122 */ diff --git a/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/time/SecondFormatter.java b/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/time/SecondFormatter.java index 064b8a294..832d3e531 100644 --- a/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/time/SecondFormatter.java +++ b/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/time/SecondFormatter.java @@ -4,7 +4,7 @@ import com.djrapitops.plan.system.settings.Settings; import com.djrapitops.plan.system.settings.config.PlanConfig; /** - * //TODO Class Javadoc Comment + * Formatter for timestamp which includes seconds as the smallest entry. * * @author Rsl1122 */ diff --git a/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/time/YearFormatter.java b/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/time/YearFormatter.java index 20b274131..1f525b241 100644 --- a/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/time/YearFormatter.java +++ b/Plan/src/main/java/com/djrapitops/plan/utilities/formatting/time/YearFormatter.java @@ -4,7 +4,7 @@ import com.djrapitops.plan.system.settings.Settings; import com.djrapitops.plan.system.settings.config.PlanConfig; /** - * //TODO Class Javadoc Comment + * Formatter for a timestamp which includes year, but not seconds. * * @author Rsl1122 */