[java-support] branch master updated: JPAR-131 - Fix doclint issues
Ian Young
ian at iay.org.uk
Wed Dec 18 12:30:05 EST 2019
This is an automated email from the git hooks/post-receive script.
iay pushed a commit to branch master
in repository java-support.
View the commit online:
http://git.shibboleth.net/view/?p=java-support.git;a=commit;h=75d11bfa3aea2c5da2457f6f2b0464f356b13a0b
The following commit(s) were added to refs/heads/master by this push:
new 75d11bf JPAR-131 - Fix doclint issues
75d11bf is described below
commit 75d11bfa3aea2c5da2457f6f2b0464f356b13a0b
Author: Ian Young <ian at iay.org.uk>
AuthorDate: Wed Dec 18 17:29:57 2019 +0000
JPAR-131 - Fix doclint issues
https://issues.shibboleth.net/jira/browse/JPAR-131
---
.../support/httpclient/ContextHandlingHttpClient.java | 3 ++-
.../support/httpclient/FileCachingHttpClientBuilder.java | 3 +--
.../java/support/httpclient/HttpClientBuilder.java | 5 +----
.../httpclient/InMemoryCachingHttpClientBuilder.java | 3 +--
.../java/support/httpclient/TLSSocketFactory.java | 3 ++-
.../utilities/java/support/net/HttpServletSupport.java | 5 +++--
.../utilities/java/support/net/MediaTypeSupport.java | 5 +++--
.../java/support/net/SimpleURLCanonicalizer.java | 5 -----
.../utilities/java/support/net/URISupport.java | 7 ++++---
.../utilities/java/support/net/URLBuilder.java | 5 +++--
.../utilities/java/support/primitive/TimerSupport.java | 6 ++----
.../utilities/java/support/resource/Resource.java | 13 ++++++++-----
.../support/security/BasicKeystoreKeyStrategyTool.java | 4 ++--
.../support/security/SelfSignedCertificateGenerator.java | 4 ++--
.../java/support/service/AbstractReloadableService.java | 6 +++---
.../java/support/service/ServiceableComponent.java | 16 ++++++++++------
.../utilities/java/support/service/package-info.java | 6 +++---
.../utilities/java/support/xml/BasicParserPool.java | 7 +++----
18 files changed, 53 insertions(+), 53 deletions(-)
diff --git a/src/main/java/net/shibboleth/utilities/java/support/httpclient/ContextHandlingHttpClient.java b/src/main/java/net/shibboleth/utilities/java/support/httpclient/ContextHandlingHttpClient.java
index b4326ec..1005e36 100644
--- a/src/main/java/net/shibboleth/utilities/java/support/httpclient/ContextHandlingHttpClient.java
+++ b/src/main/java/net/shibboleth/utilities/java/support/httpclient/ContextHandlingHttpClient.java
@@ -55,6 +55,8 @@ import net.shibboleth.utilities.java.support.logic.Constraint;
*
* <p>
* The order of execution is:
+ * </p>
+ *
* <ol>
* <li>Static handlers supplied via the constructor, in original list order</li>
* <li>Dynamic handlers from the context attribute {@link HttpClientSupport#CONTEXT_KEY_DYNAMIC_CONTEXT_HANDLERS},
@@ -64,7 +66,6 @@ import net.shibboleth.utilities.java.support.logic.Constraint;
* in reverse list order</li>
* <li>Static handlers supplied via the constructor, in reverse list order</li>
* </ol>
- * </p>
*/
class ContextHandlingHttpClient extends CloseableHttpClient {
diff --git a/src/main/java/net/shibboleth/utilities/java/support/httpclient/FileCachingHttpClientBuilder.java b/src/main/java/net/shibboleth/utilities/java/support/httpclient/FileCachingHttpClientBuilder.java
index 3d1f927..d1e5b29 100644
--- a/src/main/java/net/shibboleth/utilities/java/support/httpclient/FileCachingHttpClientBuilder.java
+++ b/src/main/java/net/shibboleth/utilities/java/support/httpclient/FileCachingHttpClientBuilder.java
@@ -60,6 +60,7 @@ import org.slf4j.LoggerFactory;
* <p>
* When using the single-arg constructor variant to wrap an existing instance of
* {@link CachingHttpClientBuilder}, there are several caveats of which to be aware:
+ * </p>
*
* <ul>
*
@@ -84,8 +85,6 @@ import org.slf4j.LoggerFactory;
* </li>
*
* </ul>
- *
- * </p>
*/
public class FileCachingHttpClientBuilder extends HttpClientBuilder {
diff --git a/src/main/java/net/shibboleth/utilities/java/support/httpclient/HttpClientBuilder.java b/src/main/java/net/shibboleth/utilities/java/support/httpclient/HttpClientBuilder.java
index 52c26a6..1ecd92d 100644
--- a/src/main/java/net/shibboleth/utilities/java/support/httpclient/HttpClientBuilder.java
+++ b/src/main/java/net/shibboleth/utilities/java/support/httpclient/HttpClientBuilder.java
@@ -136,10 +136,7 @@ import net.shibboleth.utilities.java.support.primitive.StringSupport;
* </li>
*
* </ul>
- *
- * </p>
- *
- * */
+ */
public class HttpClientBuilder {
/** Local IP address used when establishing connections. Default value: system default local address */
diff --git a/src/main/java/net/shibboleth/utilities/java/support/httpclient/InMemoryCachingHttpClientBuilder.java b/src/main/java/net/shibboleth/utilities/java/support/httpclient/InMemoryCachingHttpClientBuilder.java
index 720648e..edb368c 100644
--- a/src/main/java/net/shibboleth/utilities/java/support/httpclient/InMemoryCachingHttpClientBuilder.java
+++ b/src/main/java/net/shibboleth/utilities/java/support/httpclient/InMemoryCachingHttpClientBuilder.java
@@ -38,6 +38,7 @@ import org.apache.http.impl.client.cache.HeapResourceFactory;
* <p>
* When using the single-arg constructor variant to wrap an existing instance of
* {@link CachingHttpClientBuilder}, there are several caveats of which to be aware:
+ * </p>
*
* <ul>
*
@@ -62,8 +63,6 @@ import org.apache.http.impl.client.cache.HeapResourceFactory;
* </li>
*
* </ul>
- *
- * </p>
*/
public class InMemoryCachingHttpClientBuilder extends HttpClientBuilder {
diff --git a/src/main/java/net/shibboleth/utilities/java/support/httpclient/TLSSocketFactory.java b/src/main/java/net/shibboleth/utilities/java/support/httpclient/TLSSocketFactory.java
index 435ab24..48a296f 100644
--- a/src/main/java/net/shibboleth/utilities/java/support/httpclient/TLSSocketFactory.java
+++ b/src/main/java/net/shibboleth/utilities/java/support/httpclient/TLSSocketFactory.java
@@ -56,13 +56,14 @@ import org.slf4j.LoggerFactory;
* <p>
* This class is functionally modeled on {@link org.apache.http.conn.ssl.SSLConnectionSocketFactory},
* but provides better support for subclassing, as well as specific additional features:
+ * </p>
+ *
* <ul>
* <li>Factory hostname verifier defaults to {@link StrictHostnameVerifier} rather than
* {@link BrowserCompatHostnameVerifier}</li>
* <li>Per-request specification of enabled TLS protocols and cipher suites via {@link HttpContext} attributes.</li>
* <li>Per-request specification of hostname verifier via {@link HttpContext} attribute.</li>
* </ul>
- * </p>
*/
@ThreadSafe
public class TLSSocketFactory implements LayeredConnectionSocketFactory {
diff --git a/src/main/java/net/shibboleth/utilities/java/support/net/HttpServletSupport.java b/src/main/java/net/shibboleth/utilities/java/support/net/HttpServletSupport.java
index 6bf32f7..78da439 100644
--- a/src/main/java/net/shibboleth/utilities/java/support/net/HttpServletSupport.java
+++ b/src/main/java/net/shibboleth/utilities/java/support/net/HttpServletSupport.java
@@ -112,7 +112,9 @@ public final class HttpServletSupport {
* Validate the Content-Type of the specified request.
*
* <p>
- * 2 strategies are supported for evaluating the request's parsed content type:
+ * Two strategies are supported for evaluating the request's parsed content type:
+ * </p>
+ *
* <ol>
* <li>
* If isOneOfStrategy is true, then the {@link MediaType} parsed from the request is compared to each
@@ -126,7 +128,6 @@ public final class HttpServletSupport {
* should be passed as valid types; wildcards should not be used.
* </li>
* </ol>
- * </p>
*
* @param request the request to be validated
* @param validTypes the set of valid media types
diff --git a/src/main/java/net/shibboleth/utilities/java/support/net/MediaTypeSupport.java b/src/main/java/net/shibboleth/utilities/java/support/net/MediaTypeSupport.java
index 5d4f68b..c6a4c28 100644
--- a/src/main/java/net/shibboleth/utilities/java/support/net/MediaTypeSupport.java
+++ b/src/main/java/net/shibboleth/utilities/java/support/net/MediaTypeSupport.java
@@ -39,7 +39,9 @@ public final class MediaTypeSupport {
* Validate the specified Content-Type.
*
* <p>
- * 2 strategies are supported for evaluating a content type:
+ * Two strategies are supported for evaluating a content type:
+ * </p>
+ *
* <ol>
* <li>
* If isOneOfStrategy is true, then the {@link MediaType} parsed from the content type value is compared to each
@@ -53,7 +55,6 @@ public final class MediaTypeSupport {
* should be passed as valid types; wildcards should not be used.
* </li>
* </ol>
- * </p>
*
* @param contentType the contentType to be validated
* @param validTypes the set of valid media types
diff --git a/src/main/java/net/shibboleth/utilities/java/support/net/SimpleURLCanonicalizer.java b/src/main/java/net/shibboleth/utilities/java/support/net/SimpleURLCanonicalizer.java
index 2b5e282..1301270 100644
--- a/src/main/java/net/shibboleth/utilities/java/support/net/SimpleURLCanonicalizer.java
+++ b/src/main/java/net/shibboleth/utilities/java/support/net/SimpleURLCanonicalizer.java
@@ -33,16 +33,11 @@ import net.shibboleth.utilities.java.support.primitive.StringSupport;
/**
* This class performs simple canonicalization of a URL as follows:
*
- * <p>
* <ul>
* <li>The scheme is lower-cased.</li>
* <li>The hostname is lower-cased</li>
* <li>The port is removed if it is the default port registered for the scheme</li>
* </ul>
- * </p>
- *
- * <p>
- * </p>
*/
public final class SimpleURLCanonicalizer {
diff --git a/src/main/java/net/shibboleth/utilities/java/support/net/URISupport.java b/src/main/java/net/shibboleth/utilities/java/support/net/URISupport.java
index ca3ba49..4466b04 100644
--- a/src/main/java/net/shibboleth/utilities/java/support/net/URISupport.java
+++ b/src/main/java/net/shibboleth/utilities/java/support/net/URISupport.java
@@ -182,11 +182,12 @@ public final class URISupport {
/**
* Create a file: URI from an absolute path, dealing with the Windows, non leading "/" issue.
- * <br/>
- * Windows absolute paths have a habit of starting with a "DosDeviceName" (such as <code>C:\absolute\path</code>
+ *
+ * <p>Windows absolute paths have a habit of starting with a "DosDeviceName" (such as <code>C:\absolute\path</code>
* if we blindly convert that to a file URI by prepending "file://", then we end up with a URI which has "C:" as
* the network segment. So if we need to have an absolute file path based URI (JAAS is the example) we call this
- * method which hides the hideous implementation
+ * method which hides the hideous implementation.</p>
+ *
* @param path the absolute file path to convert
* @return a suitable URI
* @throws URISyntaxException if the URI contructor fails
diff --git a/src/main/java/net/shibboleth/utilities/java/support/net/URLBuilder.java b/src/main/java/net/shibboleth/utilities/java/support/net/URLBuilder.java
index 125472f..682bcb7 100644
--- a/src/main/java/net/shibboleth/utilities/java/support/net/URLBuilder.java
+++ b/src/main/java/net/shibboleth/utilities/java/support/net/URLBuilder.java
@@ -218,8 +218,9 @@ public class URLBuilder {
/**
* Gets the query string parameters for the URL. Params may be added and removed through the {@link List} interface.
- * <br/>
- * A note on the use of nulls in the {@link Pair}.
+ *
+ * <p>A note on the use of nulls in the {@link Pair}:</p>
+ *
* <ul><li>A null {@link Pair#getFirst()} is generated from a URL segment such as {@code ?=foo}.
* Such pairs are ignored by {@link #buildURL()}.</li>
* <li> A null {@link Pair#getSecond()} is generated from a URL segment such as {@code ?foo=&bar=fred} and
diff --git a/src/main/java/net/shibboleth/utilities/java/support/primitive/TimerSupport.java b/src/main/java/net/shibboleth/utilities/java/support/primitive/TimerSupport.java
index 45c36ce..7b38156 100644
--- a/src/main/java/net/shibboleth/utilities/java/support/primitive/TimerSupport.java
+++ b/src/main/java/net/shibboleth/utilities/java/support/primitive/TimerSupport.java
@@ -35,14 +35,13 @@ public final class TimerSupport {
/**
* Produce the name which should be used for a {@link Timer} owned by the specified object.
*
- * <p>The base name will constructed as follows:
+ * <p>The base name will be constructed as follows:</p>
* <ul>
* <li>if target is instance of {@link IdentifiedComponent},
* use {@link IdentifiedComponent#getId()} if non-empty</li>
* <li>use {@link #toString()} if non-empty</li>
* <li>use serialized class name</li>
* </ul>
- * </p>
*
* @param obj the target object instance to evaluate
* @return an appropriate name for a Timer owned by the specified object
@@ -54,14 +53,13 @@ public final class TimerSupport {
/**
* Produce the name which should be used for a {@link Timer} owned by the specified object.
*
- * <p>The base name will constructed as follows:
+ * <p>The base name will be constructed as follows:</p>
* <ul>
* <li>if target is instance of {@link IdentifiedComponent},
* use {@link IdentifiedComponent#getId()} if non-empty</li>
* <li>use {@link #toString()} if non-empty</li>
* <li>use serialized class name</li>
* </ul>
- * </p>
*
* @param obj the target object instance to evaluate
* @param additionalData additional qualifying data to include in the name
diff --git a/src/main/java/net/shibboleth/utilities/java/support/resource/Resource.java b/src/main/java/net/shibboleth/utilities/java/support/resource/Resource.java
index 388fd28..b9a2ebd 100644
--- a/src/main/java/net/shibboleth/utilities/java/support/resource/Resource.java
+++ b/src/main/java/net/shibboleth/utilities/java/support/resource/Resource.java
@@ -26,11 +26,14 @@ import java.net.URL;
import javax.annotation.Nonnull;
/**
- * An interface representing a data resource. This is API compatible with the spring Resource
- * http://docs.spring.io/spring/docs/2.5.x/api/org/springframework/core/io/Resource.html but allows Resource consuming
- * code to not require Spring.<br/>
- * Shibboleth components only implement this interface if they also implement the Spring Resource interface. Refer to
- * the Spring documentation to implement other versions of this in a spring free environment.
+ * An interface representing a data resource.
+ *
+ * <p>This is API-compatible with the
+ * <a href="http://docs.spring.io/spring/docs/2.5.x/api/org/springframework/core/io/Resource.html">Spring
+ * <code>Resource</code></a> but allows <code>Resource</code>-consuming code to not require Spring.</p>
+ *
+ * <p>Shibboleth components only implement this interface if they also implement the Spring <code>Resource</code>
+ * interface. Refer to the Spring documentation to implement other versions of this in a Spring-free environment.</p>
* */
public interface Resource {
diff --git a/src/main/java/net/shibboleth/utilities/java/support/security/BasicKeystoreKeyStrategyTool.java b/src/main/java/net/shibboleth/utilities/java/support/security/BasicKeystoreKeyStrategyTool.java
index ca329e3..c1187e6 100644
--- a/src/main/java/net/shibboleth/utilities/java/support/security/BasicKeystoreKeyStrategyTool.java
+++ b/src/main/java/net/shibboleth/utilities/java/support/security/BasicKeystoreKeyStrategyTool.java
@@ -211,7 +211,7 @@ public class BasicKeystoreKeyStrategyTool {
*
* @param args command line arguments
*
- * @throws Exception
+ * @throws Exception if something goes wrong
*/
public static void main(@Nonnull final String[] args) throws Exception {
@@ -234,7 +234,7 @@ public class BasicKeystoreKeyStrategyTool {
/**
* Constructor.
*
- * @param optionName
+ * @param optionName name of the option
*/
public FileConverter(final String optionName) {
super(optionName);
diff --git a/src/main/java/net/shibboleth/utilities/java/support/security/SelfSignedCertificateGenerator.java b/src/main/java/net/shibboleth/utilities/java/support/security/SelfSignedCertificateGenerator.java
index 8fe09dc..9443ee0 100644
--- a/src/main/java/net/shibboleth/utilities/java/support/security/SelfSignedCertificateGenerator.java
+++ b/src/main/java/net/shibboleth/utilities/java/support/security/SelfSignedCertificateGenerator.java
@@ -355,7 +355,7 @@ public class SelfSignedCertificateGenerator {
*
* @param args command line arguments
*
- * @throws Exception
+ * @throws Exception if something goes wrong
*/
public static void main(@Nonnull final String[] args) throws Exception {
@@ -378,7 +378,7 @@ public class SelfSignedCertificateGenerator {
/**
* Constructor.
*
- * @param optionName
+ * @param optionName name of the option
*/
public FileConverter(final String optionName) {
super(optionName);
diff --git a/src/main/java/net/shibboleth/utilities/java/support/service/AbstractReloadableService.java b/src/main/java/net/shibboleth/utilities/java/support/service/AbstractReloadableService.java
index 0961c20..4bc4e3d 100644
--- a/src/main/java/net/shibboleth/utilities/java/support/service/AbstractReloadableService.java
+++ b/src/main/java/net/shibboleth/utilities/java/support/service/AbstractReloadableService.java
@@ -38,9 +38,9 @@ import org.slf4j.LoggerFactory;
/**
* Base class for {@link ReloadableService}. This base class will use a background thread that will perform a periodic
- * check, via {@link #shouldReload()}, and, if required, invoke the services {@link #reload()} method. <br/>
+ * check, via {@link #shouldReload()}, and, if required, invoke the service's {@link #reload()} method.
*
- * This class does <em>not</em> deal with any synchronization. That is left to implementing classes.
+ * <p>This class does <em>not</em> deal with any synchronization; that is left to implementing classes.</p>
*
* @param <T> The sort of service this implements.
*/
@@ -262,7 +262,7 @@ public abstract class AbstractReloadableService<T> extends AbstractIdentifiableI
/**
* Return a string which is to be prepended to all log messages.
*
- * @return "Service '<definitionID>' :"
+ * @return "Service '<definitionID>' :"
*/
@Nonnull @NotEmpty protected String getLogPrefix() {
// local cache of cached entry to allow unsynchronized clearing of per class cache.
diff --git a/src/main/java/net/shibboleth/utilities/java/support/service/ServiceableComponent.java b/src/main/java/net/shibboleth/utilities/java/support/service/ServiceableComponent.java
index 7f00b58..d290ee1 100644
--- a/src/main/java/net/shibboleth/utilities/java/support/service/ServiceableComponent.java
+++ b/src/main/java/net/shibboleth/utilities/java/support/service/ServiceableComponent.java
@@ -24,8 +24,8 @@ import javax.annotation.Nonnull;
*
* The idea is that the attribute resolver will be
* <code>
- * public class AttributeResolver extends AbstractServiceableComponent<AttributeResolver> implements
- * AttributeResolver, ServiceableComponent<ServiceableComponent>.
+ * public class AttributeResolver extends AbstractServiceableComponent<AttributeResolver> implements
+ * AttributeResolver, ServiceableComponent<ServiceableComponent>.
* </code>
* AbstractServiceableComponent will do all the work around reload and synchronization.
*
@@ -43,8 +43,11 @@ public interface ServiceableComponent<T> {
/**
* This function takes a lock on the component which guarantees that it will not be disposed until the unpin call
- * is made.<br/> This method is typically <em>only</em> used during initialization of the component.<br/>
- * <em>Every call to {@link #pinComponent()} must be matched by a call to {@link #unpinComponent()}</em>.
+ * is made.
+ *
+ * <p>This method is typically <em>only</em> used during initialization of the component.</p>
+ *
+ * <p><em>Every call to {@link #pinComponent()} must be matched by a call to {@link #unpinComponent()}</em>.</p>
*/
void pinComponent();
@@ -56,8 +59,9 @@ public interface ServiceableComponent<T> {
/**
* This call will wait for all transient operations to complete and then
- * calls dispose on the components. <br/>Implementations should avoid calling
- * this with locks held.
+ * calls dispose on the components.
+ *
+ * <p>Implementations should avoid calling this with locks held.</p>
*/
void unloadComponent();
}
\ No newline at end of file
diff --git a/src/main/java/net/shibboleth/utilities/java/support/service/package-info.java b/src/main/java/net/shibboleth/utilities/java/support/service/package-info.java
index 09cdd40..924e5dc 100644
--- a/src/main/java/net/shibboleth/utilities/java/support/service/package-info.java
+++ b/src/main/java/net/shibboleth/utilities/java/support/service/package-info.java
@@ -16,9 +16,9 @@
*/
/**
- * Service support for Shibboleth projects.<br/>
- * A service is something reloads instances of serviceable components.
- *
+ * Service support for Shibboleth projects.
+ *
+ * <p>A service is something that reloads instances of serviceable components.</p>
*/
package net.shibboleth.utilities.java.support.service;
\ No newline at end of file
diff --git a/src/main/java/net/shibboleth/utilities/java/support/xml/BasicParserPool.java b/src/main/java/net/shibboleth/utilities/java/support/xml/BasicParserPool.java
index 6dec96b..204ca58 100644
--- a/src/main/java/net/shibboleth/utilities/java/support/xml/BasicParserPool.java
+++ b/src/main/java/net/shibboleth/utilities/java/support/xml/BasicParserPool.java
@@ -680,14 +680,13 @@ public class BasicParserPool extends AbstractInitializableComponent implements P
* Build the default set of parser features to use.
*
* <p>These will be overriden by a call to {@link #setBuilderFeatures(Map)}.</p>
- *
- * <p>
- * The default features set are:
+ *
+ * <p>The default features set are:</p>
+ *
* <ul>
* <li>{@link javax.xml.XMLConstants#FEATURE_SECURE_PROCESSING} = true</li>
* <li>http://apache.org/xml/features/disallow-doctype-decl = true</li>
* </ul>
- * </p>
*
* @return the default features map
*/
--
To stop receiving notification emails like this one, please contact
the administrator of this repository.
More information about the commits
mailing list