This is an automated email from the ASF dual-hosted git repository. ddekany pushed a commit to branch FREEMARKER-35 in repository https://gitbox.apache.org/repos/asf/freemarker.git
commit 05e578604666c72fdea2f95a59119d9081bbfcea Author: ddekany <[email protected]> AuthorDate: Thu Dec 16 14:18:03 2021 +0100 [FREEMARKER-35] JavaDoc error fixes --- src/main/java/freemarker/core/Configurable.java | 15 +++------------ .../freemarker/core/TemplateTemporalFormatFactory.java | 4 ++-- 2 files changed, 5 insertions(+), 14 deletions(-) diff --git a/src/main/java/freemarker/core/Configurable.java b/src/main/java/freemarker/core/Configurable.java index 385ee87..938d318 100644 --- a/src/main/java/freemarker/core/Configurable.java +++ b/src/main/java/freemarker/core/Configurable.java @@ -1326,7 +1326,7 @@ public class Configurable { * * <p>If temporal support is enabled (see {@link Configuration#setIncompatibleImprovements(Version)} at 2.3.32, and * {@link DefaultObjectWrapperBuilder#setTemporalSupport(boolean)}) this is also used for these {@link Temporal} - * classes: {@link Instance}, {@link LocalDateTime}, {@link OffsetDateTime}, {@link ZonedDateTime}. + * classes: {@link Instant}, {@link LocalDateTime}, {@link OffsetDateTime}, {@link ZonedDateTime}. * For non-{@code Local} {@link Temporal}-s FreeMarker will detect if the format doesn't show the offset or zone (as * is typically the case for the {@code "medium"} format), and then before formatting it will convert the value to * the time zone specified in the {@link #setTimeZone(TimeZone) timeZone} setting of FreeMarker, or when parsing @@ -1361,7 +1361,7 @@ public class Configurable { * <p>Defaults to {@code "iso"}, which will simply show the year like {@code "2021"} (without the quotation marks). * * @param yearFormat - * See the similar parameter of {@link #setZonedDateTimeFormat(String)}, + * See the similar parameter of {@link #setDateTimeFormat(String)}, * {@code iso}/{@code xs} only the year is shown. * Java (as of version 8) doesn't support "styles" (like "short", "medium", etc.) for this. * @@ -1395,7 +1395,7 @@ public class Configurable { * <p>Defaults to {@code "iso"}, which will show the value like {@code "2021-12"} (without the quotation marks). * * @param yearMonthFormat - * See the similar parameter of {@link #setZonedDateTimeFormat(String)}; + * See the similar parameter of {@link #setDateTimeFormat(String)}; * {@code iso}/{@code xs} will look like {@code 2021-12}. * Java (as of version 8) doesn't support "styles" (like "short", "medium", etc.) for this. * @@ -2543,15 +2543,6 @@ public class Configurable { * <li><p>{@code "date_format", "time_format", "datetime_format"}: * See {@link #setDateFormat(String)}, {@link #setTimeFormat(String)}, {@link #setDateTimeFormat(String)}. * - * <li><p>{@code "local_date_format", "local_time_format", "local_datetime_format"}: - * See {@link #setLocalDateFormat(String)}, {@link #setLocalTimeFormat(String)}, {@link #setLocalDateTimeFormat(String)}. - * - * <li><p>{@code "offset_time_format", "offset_datetime_format"}: - * See {@link #setOffsetTimeFormat(String)}, {@link #setOffsetDateTimeFormat(String)}. - * - * <li><p>{@code "zoned_date_time_format"}: - * See {@link #setZonedDateTimeFormat(String)}. - * * <li><p>{@code "year_format"}: * See {@link #setYearFormat(String)}. * diff --git a/src/main/java/freemarker/core/TemplateTemporalFormatFactory.java b/src/main/java/freemarker/core/TemplateTemporalFormatFactory.java index 5ab995b..e6cc58f 100644 --- a/src/main/java/freemarker/core/TemplateTemporalFormatFactory.java +++ b/src/main/java/freemarker/core/TemplateTemporalFormatFactory.java @@ -46,9 +46,9 @@ public abstract class TemplateTemporalFormatFactory extends TemplateValueFormatF * * @param params * The string that further describes how the format should look. For example, when the - * {@link Configurable#getInstantFormat() instantFormat} is {@code "@fooBar 1, 2"}, then it will be + * {@link Configurable#getDateTimeFormat() dateTimeFormat} is {@code "@fooBar 1, 2"}, then it will be * {@code "1, 2"} (and {@code "@fooBar"} selects the factory). The format of this string is up to the - * {@link TemplateTemporalFormatFactory} implementation. Not {@code null}, often an empty string. + * {@link TemplateTemporalFormatFactory} implementation. Not {@code null}, but often an empty string. * @param temporalClass * The type of the temporal. If this type is not supported, the method should throw an * {@link UnformattableTemporalTypeException} exception.
