[spring-extensions] branch master updated: JPAR-131 - Fix doclint issues
Ian Young
ian at iay.org.uk
Wed Dec 18 13:09:47 EST 2019
This is an automated email from the git hooks/post-receive script.
iay pushed a commit to branch master
in repository spring-extensions.
View the commit online:
http://git.shibboleth.net/view/?p=spring-extensions.git;a=commit;h=bb0a55f3f926d9f899d53e97c2b7c5ee3e8ac7c8
The following commit(s) were added to refs/heads/master by this push:
new bb0a55f JPAR-131 - Fix doclint issues
bb0a55f is described below
commit bb0a55f3f926d9f899d53e97c2b7c5ee3e8ac7c8
Author: Ian Young <ian at iay.org.uk>
AuthorDate: Wed Dec 18 18:09:36 2019 +0000
JPAR-131 - Fix doclint issues
https://issues.shibboleth.net/jira/browse/JPAR-131
---
.../shibboleth/ext/spring/config/StringToResourceConverter.java | 4 ++--
.../net/shibboleth/ext/spring/error/ErrorRaisingController.java | 2 +-
.../shibboleth/ext/spring/service/ReloadableSpringService.java | 9 ++++++---
.../ext/spring/util/AnnotationParameterNameDiscoverer.java | 5 +++--
src/main/java/net/shibboleth/ext/spring/util/SpringSupport.java | 8 +++++---
.../net/shibboleth/ext/spring/velocity/VelocityConfigurer.java | 3 +--
.../shibboleth/ext/spring/velocity/VelocityEngineFactory.java | 9 ++-------
.../ext/spring/velocity/VelocityEngineFactoryBean.java | 2 +-
8 files changed, 21 insertions(+), 21 deletions(-)
diff --git a/src/main/java/net/shibboleth/ext/spring/config/StringToResourceConverter.java b/src/main/java/net/shibboleth/ext/spring/config/StringToResourceConverter.java
index 3572a62..1726205 100644
--- a/src/main/java/net/shibboleth/ext/spring/config/StringToResourceConverter.java
+++ b/src/main/java/net/shibboleth/ext/spring/config/StringToResourceConverter.java
@@ -30,8 +30,8 @@ import org.springframework.core.io.ResourceLoader;
/**
* Allows setting {@link Resource} properties using a string representing a Spring resource. The Spring resource is
- * retrieved by the application context. If the application context is null, then a {@link DefaultResourceLoader} is
- * used instead to get the resource.
+ * retrieved by the application context. If the application context is null, then a
+ * {@link PreferFileSystemResourceLoader} is used instead to get the resource.
*/
public class StringToResourceConverter implements Converter<String, Resource>, ApplicationContextAware {
diff --git a/src/main/java/net/shibboleth/ext/spring/error/ErrorRaisingController.java b/src/main/java/net/shibboleth/ext/spring/error/ErrorRaisingController.java
index 5c9587e..415ee89 100644
--- a/src/main/java/net/shibboleth/ext/spring/error/ErrorRaisingController.java
+++ b/src/main/java/net/shibboleth/ext/spring/error/ErrorRaisingController.java
@@ -39,7 +39,7 @@ public class ErrorRaisingController {
*
* @param httpRequest the HTTP request
*
- * @throws Throwable
+ * @throws Throwable if something goes wrong
*/
@RequestMapping(value = "/RaiseError")
// Checkstyle: IllegalThrows OFF
diff --git a/src/main/java/net/shibboleth/ext/spring/service/ReloadableSpringService.java b/src/main/java/net/shibboleth/ext/spring/service/ReloadableSpringService.java
index 02e1cd3..fb2d1f8 100644
--- a/src/main/java/net/shibboleth/ext/spring/service/ReloadableSpringService.java
+++ b/src/main/java/net/shibboleth/ext/spring/service/ReloadableSpringService.java
@@ -57,7 +57,7 @@ import org.springframework.core.io.Resource;
/**
* This class provides a reloading interface to a {@link ServiceableComponent} via Spring.
* This class extends {@link org.springframework.context.Lifecycle}. and thus
- * It acts as the bridge between this interface and
+ * it acts as the bridge between this interface and
* {@link net.shibboleth.utilities.java.support.component.InitializableComponent} and
* {@link net.shibboleth.utilities.java.support.component.DestructableComponent}
@@ -203,8 +203,11 @@ public class ReloadableSpringService<T> extends AbstractReloadableService<T> imp
}
}
- /** Set the strategy by which the Service can locate the resources it needs to know about.
- * <br/> Not implemented
+ /**
+ * Set the strategy by which the Service can locate the resources it needs to know about.
+ *
+ * <p>Not implemented.</p>
+ *
* @param strategy the way to get the resources. Precise details are tbd.
*/
public void setServiceConfigurationStrategy(@Nonnull final Function<?, List<Resource>> strategy) {
diff --git a/src/main/java/net/shibboleth/ext/spring/util/AnnotationParameterNameDiscoverer.java b/src/main/java/net/shibboleth/ext/spring/util/AnnotationParameterNameDiscoverer.java
index bd6871e..5bd7a1d 100644
--- a/src/main/java/net/shibboleth/ext/spring/util/AnnotationParameterNameDiscoverer.java
+++ b/src/main/java/net/shibboleth/ext/spring/util/AnnotationParameterNameDiscoverer.java
@@ -62,8 +62,9 @@ public class AnnotationParameterNameDiscoverer extends DefaultParameterNameDisco
}
/**
- * {@inheritDoc} <br/>
- * If we cannot do anything pass to the default discoverer.
+ * {@inheritDoc}
+ *
+ * <p>If we cannot do anything pass to the default discoverer.</p>
*/
@Override public String[] getParameterNames(final Constructor<?> ctor) {
diff --git a/src/main/java/net/shibboleth/ext/spring/util/SpringSupport.java b/src/main/java/net/shibboleth/ext/spring/util/SpringSupport.java
index b5b0bc2..d9f3c7d 100644
--- a/src/main/java/net/shibboleth/ext/spring/util/SpringSupport.java
+++ b/src/main/java/net/shibboleth/ext/spring/util/SpringSupport.java
@@ -139,11 +139,13 @@ public final class SpringSupport {
}
}
- /** Root method for all parsing.
+ /**
+ * Root method for all parsing.
*
- * @param element the element to parse.<br/>This works in two scoping modes. If the parent builder is
+ * @param element the element to parse.
+ * <p>This works in two scoping modes. If the parent builder is
* null then this bean is to be inserted into the provided parser context, in this case the parent builder is null.
- * If the parent builder is provided then the scope is limited and the bean definition is returned.
+ * If the parent builder is provided then the scope is limited and the bean definition is returned.</p>
* @param parserContext current parsing context
* @param parentBuilder the parent builder (for nested building).
* @param lazyInit whether this is lazy initialized;
diff --git a/src/main/java/net/shibboleth/ext/spring/velocity/VelocityConfigurer.java b/src/main/java/net/shibboleth/ext/spring/velocity/VelocityConfigurer.java
index c848f63..c8c93cd 100644
--- a/src/main/java/net/shibboleth/ext/spring/velocity/VelocityConfigurer.java
+++ b/src/main/java/net/shibboleth/ext/spring/velocity/VelocityConfigurer.java
@@ -51,7 +51,7 @@ import org.springframework.web.context.ServletContextAware;
*
* <p>Note that you can also refer to a pre-configured VelocityEngine
* instance via the "velocityEngine" property, e.g. set up by
- * {@link org.springframework.ui.velocity.VelocityEngineFactoryBean},
+ * {@link VelocityEngineFactoryBean},
* This allows to share a VelocityEngine for web and email usage, for example.
*
* <p>This configurer registers the "spring.vm" Velocimacro library for web views
@@ -96,7 +96,6 @@ public class VelocityConfigurer extends VelocityEngineFactory
* Initialize VelocityEngineFactory's VelocityEngine
* if not overridden by a pre-configured VelocityEngine.
* @see #createVelocityEngine
- * @see #setVelocityEngine
*/
@Override
public void afterPropertiesSet() throws IOException, VelocityException {
diff --git a/src/main/java/net/shibboleth/ext/spring/velocity/VelocityEngineFactory.java b/src/main/java/net/shibboleth/ext/spring/velocity/VelocityEngineFactory.java
index d247482..25a4748 100644
--- a/src/main/java/net/shibboleth/ext/spring/velocity/VelocityEngineFactory.java
+++ b/src/main/java/net/shibboleth/ext/spring/velocity/VelocityEngineFactory.java
@@ -42,7 +42,7 @@ import org.springframework.util.StringUtils;
* Factory that configures a VelocityEngine. Can be used standalone,
* but typically you will either use {@link VelocityEngineFactoryBean}
* for preparing a VelocityEngine as bean reference, or
- * {@link org.springframework.web.servlet.view.velocity.VelocityConfigurer}
+ * {@link VelocityConfigurer}
* for web views.
*
* <p>The optional "configLocation" property sets the location of the Velocity
@@ -54,10 +54,6 @@ import org.springframework.util.StringUtils;
* resource loader path via Spring's Resource abstraction, possibly relative
* to the Spring application context.
*
- * <p>If "overrideLogging" is true (the default), the VelocityEngine will be
- * configured to log via Commons Logging, that is, using
- * {@link CommonsLogLogChute} as log system.
- *
* <p>The simplest way to use this class is to specify a
* {@link #setResourceLoaderPath(String) "resourceLoaderPath"}; the
* VelocityEngine typically then does not need any further configuration.
@@ -66,10 +62,9 @@ import org.springframework.util.StringUtils;
* @see #setConfigLocation
* @see #setVelocityProperties
* @see #setResourceLoaderPath
- * @see #setOverrideLogging
* @see #createVelocityEngine
* @see VelocityEngineFactoryBean
- * @see org.springframework.web.servlet.view.velocity.VelocityConfigurer
+ * @see VelocityConfigurer
* @see org.apache.velocity.app.VelocityEngine
*
* @since 6.0.0
diff --git a/src/main/java/net/shibboleth/ext/spring/velocity/VelocityEngineFactoryBean.java b/src/main/java/net/shibboleth/ext/spring/velocity/VelocityEngineFactoryBean.java
index e69ae6b..3223e6b 100644
--- a/src/main/java/net/shibboleth/ext/spring/velocity/VelocityEngineFactoryBean.java
+++ b/src/main/java/net/shibboleth/ext/spring/velocity/VelocityEngineFactoryBean.java
@@ -49,7 +49,7 @@ import org.springframework.context.ResourceLoaderAware;
* @see #setConfigLocation
* @see #setVelocityProperties
* @see #setResourceLoaderPath
- * @see org.springframework.web.servlet.view.velocity.VelocityConfigurer
+ * @see VelocityConfigurer
*
* @since 6.0.0
*/
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list