From ac28de0dc136fd9e56d476b99084be86fc8ba36d Mon Sep 17 00:00:00 2001 From: Sam Brannen Date: Mon, 10 Jun 2019 16:03:16 +0300 Subject: [PATCH] Polish Javadoc for FreeMarker support --- .../web/reactive/result/view/RequestContext.java | 4 ++-- .../web/reactive/result/view/UrlBasedViewResolver.java | 2 +- .../result/view/freemarker/FreeMarkerConfigurer.java | 2 +- .../web/reactive/result/view/freemarker/FreeMarkerView.java | 2 +- .../web/servlet/view/freemarker/FreeMarkerConfigurer.java | 5 ++--- .../web/servlet/view/freemarker/FreeMarkerView.java | 5 +++-- .../springframework/web/servlet/view/freemarker/spring.ftl | 2 +- 7 files changed, 11 insertions(+), 11 deletions(-) diff --git a/spring-webflux/src/main/java/org/springframework/web/reactive/result/view/RequestContext.java b/spring-webflux/src/main/java/org/springframework/web/reactive/result/view/RequestContext.java index d4f6db5f97..0364aa079e 100644 --- a/spring-webflux/src/main/java/org/springframework/web/reactive/result/view/RequestContext.java +++ b/spring-webflux/src/main/java/org/springframework/web/reactive/result/view/RequestContext.java @@ -44,10 +44,10 @@ import org.springframework.web.util.UriTemplate; * use, current locale, binding errors, etc. Provides easy access to localized * messages and Errors instances. * - *

Suitable for exposition to views, and usage within FreeMarker templates, + *

Suitable for exposition to views, and usage within FreeMarker templates * and tag libraries. * - *

Can be instantiated manually, or automatically exposed to views as model + *

Can be instantiated manually or automatically exposed to views as a model * attribute via AbstractView's "requestContextAttribute" property. * * @author Rossen Stoyanchev diff --git a/spring-webflux/src/main/java/org/springframework/web/reactive/result/view/UrlBasedViewResolver.java b/spring-webflux/src/main/java/org/springframework/web/reactive/result/view/UrlBasedViewResolver.java index 1e51c1a88c..8ac251a338 100644 --- a/spring-webflux/src/main/java/org/springframework/web/reactive/result/view/UrlBasedViewResolver.java +++ b/spring-webflux/src/main/java/org/springframework/web/reactive/result/view/UrlBasedViewResolver.java @@ -188,7 +188,7 @@ public class UrlBasedViewResolver extends ViewResolverSupport } /** - * Return the name of the @link RequestContext} attribute for all views, if any. + * Return the name of the {@link RequestContext} attribute for all views, if any. */ @Nullable protected String getRequestContextAttribute() { diff --git a/spring-webflux/src/main/java/org/springframework/web/reactive/result/view/freemarker/FreeMarkerConfigurer.java b/spring-webflux/src/main/java/org/springframework/web/reactive/result/view/freemarker/FreeMarkerConfigurer.java index fbeaee6c92..179e9c319c 100644 --- a/spring-webflux/src/main/java/org/springframework/web/reactive/result/view/freemarker/FreeMarkerConfigurer.java +++ b/spring-webflux/src/main/java/org/springframework/web/reactive/result/view/freemarker/FreeMarkerConfigurer.java @@ -40,7 +40,7 @@ import org.springframework.util.Assert; * using {@link FreeMarkerView}. It exists purely to configure FreeMarker. * It is not meant to be referenced by application components but just internally * by {@code FreeMarkerView}. Implements {@link FreeMarkerConfig} to be found by - * {@code FreeMarkerView} without depending on the bean name the configurer. + * {@code FreeMarkerView} without depending on the bean name of the configurer. * *

Note that you can also refer to a pre-configured FreeMarker Configuration * instance via the "configuration" property. This allows to share a FreeMarker diff --git a/spring-webflux/src/main/java/org/springframework/web/reactive/result/view/freemarker/FreeMarkerView.java b/spring-webflux/src/main/java/org/springframework/web/reactive/result/view/freemarker/FreeMarkerView.java index 399c6e47fc..52a0c4e3a4 100644 --- a/spring-webflux/src/main/java/org/springframework/web/reactive/result/view/freemarker/FreeMarkerView.java +++ b/spring-webflux/src/main/java/org/springframework/web/reactive/result/view/freemarker/FreeMarkerView.java @@ -54,7 +54,7 @@ import org.springframework.web.server.ServerWebExchange; * *

Depends on a single {@link FreeMarkerConfig} object such as * {@link FreeMarkerConfigurer} being accessible in the application context. - * Alternatively set the FreeMarker configuration can be set directly on this + * Alternatively the FreeMarker configuration can be set directly on this * class via {@link #setConfiguration}. * *

The {@link #setUrl(String) url} property is the location of the FreeMarker diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/view/freemarker/FreeMarkerConfigurer.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/view/freemarker/FreeMarkerConfigurer.java index 8438cca8dd..2eac60f2ae 100644 --- a/spring-webmvc/src/main/java/org/springframework/web/servlet/view/freemarker/FreeMarkerConfigurer.java +++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/view/freemarker/FreeMarkerConfigurer.java @@ -48,7 +48,7 @@ import org.springframework.web.context.ServletContextAware; * using Spring's FreeMarkerView for web MVC. It exists purely to configure FreeMarker. * It is not meant to be referenced by application components but just internally * by FreeMarkerView. Implements FreeMarkerConfig to be found by FreeMarkerView without - * depending on the bean name the configurer. Each DispatcherServlet can define its + * depending on the bean name of the configurer. Each DispatcherServlet can define its * own FreeMarkerConfigurer if desired. * *

Note that you can also refer to a preconfigured FreeMarker Configuration @@ -57,8 +57,7 @@ import org.springframework.web.context.ServletContextAware; * for web and email usage, for example. * *

This configurer registers a template loader for this package, allowing to - * reference the "spring.ftl" macro library (contained in this package and thus - * in spring.jar) like this: + * reference the "spring.ftl" macro library contained in this package: * * 

  * <#import "/spring.ftl" as spring/>
diff --git a/spring-webmvc/src/main/java/org/springframework/web/servlet/view/freemarker/FreeMarkerView.java b/spring-webmvc/src/main/java/org/springframework/web/servlet/view/freemarker/FreeMarkerView.java
index c36523dd43..356d4b9618 100644
--- a/spring-webmvc/src/main/java/org/springframework/web/servlet/view/freemarker/FreeMarkerView.java
+++ b/spring-webmvc/src/main/java/org/springframework/web/servlet/view/freemarker/FreeMarkerView.java
@@ -70,8 +70,9 @@ import org.springframework.web.servlet.view.AbstractTemplateView;
  *
  * 
Depends on a single {@link FreeMarkerConfig} object such as {@link FreeMarkerConfigurer}
  * being accessible in the current web application context, with any bean name.
- * Alternatively, you can set the FreeMarker {@link Configuration} object as bean property.
- * See {@link #setConfiguration} for more details on the impacts of this approach.
+ * Alternatively, you can set the FreeMarker {@link Configuration} object as a
+ * bean property. See {@link #setConfiguration} for more details on the impacts
+ * of this approach.
  *
  * 
Note: Spring's FreeMarker support requires FreeMarker 2.3 or higher.
  *
diff --git a/spring-webmvc/src/main/resources/org/springframework/web/servlet/view/freemarker/spring.ftl b/spring-webmvc/src/main/resources/org/springframework/web/servlet/view/freemarker/spring.ftl
index ec93e722ae..656933eb6d 100644
--- a/spring-webmvc/src/main/resources/org/springframework/web/servlet/view/freemarker/spring.ftl
+++ b/spring-webmvc/src/main/resources/org/springframework/web/servlet/view/freemarker/spring.ftl
@@ -11,7 +11,7 @@
  * FreeMarkerConfigurer.
  *
  * To take advantage of these macros, the "exposeSpringMacroHelpers" property
- * of the FreeMarker class needs to be set to "true". This will expose a
+ * of the FreeMarkerView class needs to be set to "true". This will expose a
  * RequestContext under the name "springMacroRequestContext", as needed by
  * the macros in this library.
  *