Polish Javadoc in the Spring MVC Test Framework

Author: sbrannen

spring-test/src/main/java/org/springframework/test/web/servlet/result/ContentResultMatchers.java

@@ -34,8 +34,9 @@
 import static org.springframework.test.util.AssertionErrors.*;
 
 /**
- * Factory for response content assertions. An instance of this class is
- * typically accessed via {@link MockMvcResultMatchers#content()}.
+ * Factory for response content assertions.
+ * <p>An instance of this class is typically accessed via
+ * {@link MockMvcResultMatchers#content}.
  *
  * @author Rossen Stoyanchev
  * @since 3.2
@@ -213,7 +214,7 @@ public void match(MvcResult result) throws Exception {
 
 	/**
 	 * Parse the response content and the given string as JSON and assert the two
-	 * are "similar" - i.e. they contain the same attribute-value pairs
+	 * are "similar" &mdash; i.e. they contain the same attribute-value pairs
 	 * regardless of order and formatting.
 	 * <p>Use of this matcher requires the <a
 	 * href="http://jsonassert.skyscreamer.org/">JSONassert<a/> library.

spring-test/src/main/java/org/springframework/test/web/servlet/result/CookieResultMatchers.java

@@ -27,8 +27,9 @@
 import static org.springframework.test.util.AssertionErrors.*;
 
 /**
- * Factory for response cookie assertions. An instance of this class is
- * typically accessed via {@link MockMvcResultMatchers#cookie()}.
+ * Factory for response cookie assertions.
+ * <p>An instance of this class is typically accessed via
+ * {@link MockMvcResultMatchers#cookie}.
  *
  * @author Rossen Stoyanchev
  * @author Thomas Bruyelle

spring-test/src/main/java/org/springframework/test/web/servlet/result/FlashAttributeResultMatchers.java

@@ -25,8 +25,9 @@
 import static org.springframework.test.util.AssertionErrors.*;
 
 /**
- * Factory for "output" flash attribute assertions. An instance of this class is
- * typically accessed via {@link MockMvcResultMatchers#flash()}.
+ * Factory for "output" flash attribute assertions.
+ * <p>An instance of this class is typically accessed via
+ * {@link MockMvcResultMatchers#flash}.
  *
  * @author Rossen Stoyanchev
  * @since 3.2

spring-test/src/main/java/org/springframework/test/web/servlet/result/HandlerResultMatchers.java

@@ -31,8 +31,9 @@
 import static org.springframework.test.util.AssertionErrors.*;
 
 /**
- * Factory for assertions on the selected handler. An instance of this class is
- * typically accessed via {@link MockMvcResultMatchers#handler()}.
+ * Factory for assertions on the selected handler.
+ * <p>An instance of this class is typically accessed via
+ * {@link MockMvcResultMatchers#handler}.
  *
  * @author Rossen Stoyanchev
  * @since 3.2

spring-test/src/main/java/org/springframework/test/web/servlet/result/HeaderResultMatchers.java

@@ -25,8 +25,9 @@
 import static org.springframework.test.util.AssertionErrors.*;
 
 /**
- * Factory for response header assertions. An instance of this
- * class is usually accessed via {@link MockMvcResultMatchers#header()}.
+ * Factory for response header assertions.
+ * <p>An instance of this class is usually accessed via
+ * {@link MockMvcResultMatchers#header}.
  *
  * @author Rossen Stoyanchev
  * @author Sam Brannen

spring-test/src/main/java/org/springframework/test/web/servlet/result/JsonPathResultMatchers.java

@@ -25,7 +25,7 @@
 /**
  * Factory for assertions on the response content using
  * <a href="http://goessner.net/articles/JsonPath/">JSONPath</a> expressions.
- * An instance of this class is typically accessed via
+ * <p>An instance of this class is typically accessed via
  * {@link MockMvcResultMatchers#jsonPath}.
  *
  * @author Rossen Stoyanchev

spring-test/src/main/java/org/springframework/test/web/servlet/result/MockMvcResultHandlers.java

@@ -29,10 +29,11 @@
 import org.springframework.util.CollectionUtils;
 
 /**
- * Static, factory methods for {@link ResultHandler}-based result actions.
+ * Static factory methods for {@link ResultHandler}-based result actions.
  *
- * <p><strong>Eclipse users:</strong> consider adding this class as a Java editor
- * favorite. To navigate to this setting, open the Preferences and type "favorites".
+ * <h3>Eclipse Users</h3>
+ * <p>Consider adding this class as a Java editor favorite. To navigate to
+ * this setting, open the Preferences and type "favorites".
  *
  * @author Rossen Stoyanchev
  * @author Sam Brannen

spring-test/src/main/java/org/springframework/test/web/servlet/result/MockMvcResultMatchers.java

@@ -28,10 +28,11 @@
 import static org.springframework.test.util.AssertionErrors.*;
 
 /**
- * Static, factory methods for {@link ResultMatcher}-based result actions.
+ * Static factory methods for {@link ResultMatcher}-based result actions.
  *
- * <p><strong>Eclipse users:</strong> consider adding this class as a Java editor
- * favorite. To navigate, open the Preferences and type "favorites".
+ * <h3>Eclipse Users</h3>
+ * <p>Consider adding this class as a Java editor favorite. To navigate to
+ * this setting, open the Preferences and type "favorites".
  *
  * @author Rossen Stoyanchev
  * @author Brian Clozel

spring-test/src/main/java/org/springframework/test/web/servlet/result/ModelResultMatchers.java

@@ -29,8 +29,9 @@
 import static org.springframework.test.util.AssertionErrors.*;
 
 /**
- * Factory for assertions on the model. An instance of this class is
- * typically accessed via {@link MockMvcResultMatchers#model()}.
+ * Factory for assertions on the model.
+ * <p>An instance of this class is typically accessed via
+ * {@link MockMvcResultMatchers#model}.
  *
  * @author Rossen Stoyanchev
  * @since 3.2

spring-test/src/main/java/org/springframework/test/web/servlet/result/RequestResultMatchers.java

@@ -31,8 +31,9 @@
 import static org.springframework.test.util.AssertionErrors.*;
 
 /**
- * Factory for assertions on the request. An instance of this class is
- * typically accessed via {@link MockMvcResultMatchers#request()}.
+ * Factory for assertions on the request.
+ * <p>An instance of this class is typically accessed via
+ * {@link MockMvcResultMatchers#request}.
  *
  * @author Rossen Stoyanchev
  * @since 3.2

spring-test/src/main/java/org/springframework/test/web/servlet/result/StatusResultMatchers.java

@@ -26,8 +26,9 @@
 import static org.springframework.test.util.AssertionErrors.*;
 
 /**
- * Factory for assertions on the response status. An instance of this class is
- * typically accessed via {@link MockMvcResultMatchers#status()}.
+ * Factory for assertions on the response status.
+ * <p>An instance of this class is typically accessed via
+ * {@link MockMvcResultMatchers#status}.
  *
  * @author Keesun Baik
  * @author Rossen Stoyanchev

spring-test/src/main/java/org/springframework/test/web/servlet/result/ViewResultMatchers.java

@@ -26,8 +26,9 @@
 import static org.springframework.test.util.AssertionErrors.*;
 
 /**
- * Factory for assertions on the selected view. An instance of this class is
- * typically accessed via {@link MockMvcResultMatchers#view()}.
+ * Factory for assertions on the selected view.
+ * <p>An instance of this class is typically accessed via
+ * {@link MockMvcResultMatchers#view}.
  *
  * @author Rossen Stoyanchev
  * @since 3.2

spring-test/src/main/java/org/springframework/test/web/servlet/result/XpathResultMatchers.java

@@ -28,8 +28,8 @@
 import org.springframework.test.web.servlet.ResultMatcher;
 
 /**
- * Factory for response content {@code ResultMatcher}'s using an XPath
- * expression. An instance of this class is typically accessed via
+ * Factory for assertions on the response content using XPath expressions.
+ * <p>An instance of this class is typically accessed via
  * {@link MockMvcResultMatchers#xpath}.
  *
  * @author Rossen Stoyanchev

spring-test/src/main/java/org/springframework/test/web/servlet/result/package-info.java

@@ -1,7 +1,7 @@
 /**
  * Contains built-in {@code ResultMatcher} and {@code ResultHandler} implementations.
- * Use {@link org.springframework.test.web.servlet.result.MockMvcResultMatchers}
+ * <p>Use {@link org.springframework.test.web.servlet.result.MockMvcResultMatchers}
  * and {@link org.springframework.test.web.servlet.result.MockMvcResultHandlers}
- * to access to instances of those implementations.
+ * to access instances of those implementations.
  */
 package org.springframework.test.web.servlet.result;