Repository: incubator-freemarker Updated Branches: refs/heads/3 f6eebd856 -> 14e4250f9
(Better JavaDoc for Environment.formatToPlainTextOrMarkup) Project: http://git-wip-us.apache.org/repos/asf/incubator-freemarker/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-freemarker/commit/14e4250f Tree: http://git-wip-us.apache.org/repos/asf/incubator-freemarker/tree/14e4250f Diff: http://git-wip-us.apache.org/repos/asf/incubator-freemarker/diff/14e4250f Branch: refs/heads/3 Commit: 14e4250f9cb5f1b9cf5c2b1ccdc49c8ffbf102cd Parents: f6eebd8 Author: ddekany <ddek...@apache.org> Authored: Thu Sep 14 11:21:49 2017 +0200 Committer: ddekany <ddek...@apache.org> Committed: Thu Sep 14 11:21:49 2017 +0200 ---------------------------------------------------------------------- .../java/org/apache/freemarker/core/Environment.java | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-freemarker/blob/14e4250f/freemarker-core/src/main/java/org/apache/freemarker/core/Environment.java ---------------------------------------------------------------------- diff --git a/freemarker-core/src/main/java/org/apache/freemarker/core/Environment.java b/freemarker-core/src/main/java/org/apache/freemarker/core/Environment.java index e6c273e..e1f9993 100644 --- a/freemarker-core/src/main/java/org/apache/freemarker/core/Environment.java +++ b/freemarker-core/src/main/java/org/apache/freemarker/core/Environment.java @@ -1029,10 +1029,13 @@ public final class Environment extends MutableProcessingConfiguration<Environmen /** * Converts a value to plain text {@link String}, or to {@link TemplateMarkupOutputModel} if that's what the - * {@link TemplateValueFormat} involved prefer to produce. (Most {@link TemplateValueFormat} produce plain text, - * markup producting formatters are very rare.) This will only convert values that <code>${value}</code> would too, - * for example, it will throw {@link TemplateException} if you try to convert a sequence or a date whose type is not - * known. + * {@link TemplateValueFormat} involved prefer to produce, similarly as <code>${value}</code> would do it. (Most + * {@link TemplateValueFormat} produce plain text, markup producing formatters are very rare.) This will only + * convert values that <code>${value}</code> would too, for example, it will throw {@link TemplateException} if you + * try to convert a sequence or a date whose type is not known. + * + * <p>Note that just like the output <code>${value}</code>, the results is intended for human audience, as + * opposed to computer audience. For example, the number 1234567 will be possibly formatted as {@code "1,234,567"}. * * @return Never {@code null} *
