Improve VersionResourceResolve javadoc

The `pathPatterns` args are relative to the patterns configured for the
resource handler.

Issue: SPR-14817
This commit is contained in:
Brian Clozel 2016-12-13 10:43:27 +01:00
parent 885e76bdd0
commit 52f664139f
2 changed files with 12 additions and 6 deletions

View File

@ -96,7 +96,8 @@ public class VersionResourceResolver extends AbstractResourceResolver {
* default strategy to use except when it cannot be, for example when using * default strategy to use except when it cannot be, for example when using
* JavaScript module loaders, use {@link #addFixedVersionStrategy} instead * JavaScript module loaders, use {@link #addFixedVersionStrategy} instead
* for serving JavaScript files. * for serving JavaScript files.
* @param pathPatterns one or more resource URL path patterns * @param pathPatterns one or more resource URL path patterns,
* relative to the pattern configured with the resource handler
* @return the current instance for chained method invocation * @return the current instance for chained method invocation
* @see ContentVersionStrategy * @see ContentVersionStrategy
*/ */
@ -118,7 +119,8 @@ public class VersionResourceResolver extends AbstractResourceResolver {
* will also cofigure automatically a {@code "/v1.0.0/js/**"} with {@code "v1.0.0"} the * will also cofigure automatically a {@code "/v1.0.0/js/**"} with {@code "v1.0.0"} the
* {@code version} String given as an argument. * {@code version} String given as an argument.
* @param version a version string * @param version a version string
* @param pathPatterns one or more resource URL path patterns * @param pathPatterns one or more resource URL path patterns,
* relative to the pattern configured with the resource handler
* @return the current instance for chained method invocation * @return the current instance for chained method invocation
* @see FixedVersionStrategy * @see FixedVersionStrategy
*/ */
@ -139,7 +141,8 @@ public class VersionResourceResolver extends AbstractResourceResolver {
* Register a custom VersionStrategy to apply to resource URLs that match the * Register a custom VersionStrategy to apply to resource URLs that match the
* given path patterns. * given path patterns.
* @param strategy the custom strategy * @param strategy the custom strategy
* @param pathPatterns one or more resource URL path patterns * @param pathPatterns one or more resource URL path patterns,
* relative to the pattern configured with the resource handler
* @return the current instance for chained method invocation * @return the current instance for chained method invocation
* @see VersionStrategy * @see VersionStrategy
*/ */

View File

@ -94,7 +94,8 @@ public class VersionResourceResolver extends AbstractResourceResolver {
* default strategy to use except when it cannot be, for example when using * default strategy to use except when it cannot be, for example when using
* JavaScript module loaders, use {@link #addFixedVersionStrategy} instead * JavaScript module loaders, use {@link #addFixedVersionStrategy} instead
* for serving JavaScript files. * for serving JavaScript files.
* @param pathPatterns one or more resource URL path patterns * @param pathPatterns one or more resource URL path patterns,
* relative to the pattern configured with the resource handler
* @return the current instance for chained method invocation * @return the current instance for chained method invocation
* @see ContentVersionStrategy * @see ContentVersionStrategy
*/ */
@ -116,7 +117,8 @@ public class VersionResourceResolver extends AbstractResourceResolver {
* will also cofigure automatically a {@code "/v1.0.0/js/**"} with {@code "v1.0.0"} the * will also cofigure automatically a {@code "/v1.0.0/js/**"} with {@code "v1.0.0"} the
* {@code version} String given as an argument. * {@code version} String given as an argument.
* @param version a version string * @param version a version string
* @param pathPatterns one or more resource URL path patterns * @param pathPatterns one or more resource URL path patterns,
* relative to the pattern configured with the resource handler
* @return the current instance for chained method invocation * @return the current instance for chained method invocation
* @see FixedVersionStrategy * @see FixedVersionStrategy
*/ */
@ -137,7 +139,8 @@ public class VersionResourceResolver extends AbstractResourceResolver {
* Register a custom VersionStrategy to apply to resource URLs that match the * Register a custom VersionStrategy to apply to resource URLs that match the
* given path patterns. * given path patterns.
* @param strategy the custom strategy * @param strategy the custom strategy
* @param pathPatterns one or more resource URL path patterns * @param pathPatterns one or more resource URL path patterns,
* relative to the pattern configured with the resource handler
* @return the current instance for chained method invocation * @return the current instance for chained method invocation
* @see VersionStrategy * @see VersionStrategy
*/ */