JavaDoc improved/fixed for getLocale/setLocale
Project: http://git-wip-us.apache.org/repos/asf/incubator-freemarker/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-freemarker/commit/a05998df Tree: http://git-wip-us.apache.org/repos/asf/incubator-freemarker/tree/a05998df Diff: http://git-wip-us.apache.org/repos/asf/incubator-freemarker/diff/a05998df Branch: refs/heads/2.3 Commit: a05998df23a4557cad7f046c07afd49b957f9efe Parents: ec1e52b Author: ddekany <[email protected]> Authored: Sat Mar 25 11:46:26 2017 +0100 Committer: ddekany <[email protected]> Committed: Sat Mar 25 11:46:26 2017 +0100 ---------------------------------------------------------------------- src/main/java/freemarker/core/Configurable.java | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/a05998df/src/main/java/freemarker/core/Configurable.java ---------------------------------------------------------------------- diff --git a/src/main/java/freemarker/core/Configurable.java b/src/main/java/freemarker/core/Configurable.java index 1563a4e..f986c0f 100644 --- a/src/main/java/freemarker/core/Configurable.java +++ b/src/main/java/freemarker/core/Configurable.java @@ -619,8 +619,10 @@ public class Configurable { } /** - * Sets the default locale used for number and date formatting (among others), also the locale used for searching - * localized template variations when no locale was explicitly requested. + * Sets the locale used for number and date formatting (among others), also the locale used for searching + * localized template variations when no locale was explicitly requested. On the {@link Configuration} level it + * defaults to the default locale of system (of the JVM), for server-side application usually you should set it + * explicitly in the {@link Configuration} to use the preferred locale of your application instead. * * @see Configuration#getTemplate(String, Locale) */ @@ -631,8 +633,7 @@ public class Configurable { } /** - * Returns the assumed locale when searching for template files with no - * explicit requested locale. Defaults to system locale. + * Getter pair of {@link #setLocale(Locale)}. Not {@code null}. */ public Locale getLocale() { return locale != null ? locale : parent.getLocale();
