Skip to content

Commit 4ffe014

Browse files
committed
Fix Javadoc errors
See gh-1467
1 parent 30d5f1e commit 4ffe014

File tree

27 files changed

+86
-162
lines changed

27 files changed

+86
-162
lines changed

pom.xml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,6 @@
3636

3737
<properties>
3838
<java.version>17</java.version>
39-
<maven.javadoc.failOnError>false</maven.javadoc.failOnError>
4039
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
4140
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
4241
<spring-asciidoctor-backends.version>0.0.5</spring-asciidoctor-backends.version>
@@ -827,7 +826,7 @@
827826
<artifactId>maven-javadoc-plugin</artifactId>
828827
<version>2.10.4</version>
829828
<configuration>
830-
<additionalparam>-Xdoclint:none</additionalparam>
829+
<additionalparam>-Xdoclint:-missing</additionalparam>
831830
<additionalparam>-quiet</additionalparam>
832831
</configuration>
833832
<executions>

spring-ws-core/src/main/java/org/springframework/ws/client/core/WebServiceTemplate.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -94,14 +94,14 @@
9494
* <li>Call {@link #hasError(WebServiceConnection,WebServiceMessage) hasError()} to check
9595
* if the connection has an error. For an HTTP transport, a status code other than
9696
* {@code 2xx} indicates an error. However, since a status code of 500 can also indicate a
97-
* SOAP fault, the template verifies whether the error is not a fault.</li>
97+
* SOAP fault, the template verifies whether the error is not a fault.
9898
* <ul>
9999
* <li>If the connection has an error, call the {@link #handleError handleError()} method,
100100
* which by default throws a {@link WebServiceTransportException}.</li>
101101
* <li>If the connection has no error, continue with the next step.</li>
102102
* </ul>
103103
* <li>Invoke {@link WebServiceConnection#receive(WebServiceMessageFactory) receive} on
104-
* the connection to read the response message, if any.</li>
104+
* the connection to read the response message, if any.
105105
* <ul>
106106
* <li>If no response was received, return {@code null} or {@code false}</li>
107107
* <li>Call {@link #hasFault(WebServiceConnection,WebServiceMessage) hasFault()} to

spring-ws-core/src/main/java/org/springframework/ws/client/core/support/WebServiceGatewaySupport.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
* template are to be used.
4242
* <p>
4343
* Note that when {@link #setWebServiceTemplate(WebServiceTemplate) injecting a
44-
* {@code WebServiceTemplate}} directly, the convenience setters
44+
* WebServiceTemplate directly}, the convenience setters
4545
* ({@link #setMarshaller(Marshaller)}, {@link #setUnmarshaller(Unmarshaller)},
4646
* {@link #setMessageSender(WebServiceMessageSender)},
4747
* {@link #setMessageSenders(WebServiceMessageSender[])}, and

spring-ws-core/src/main/java/org/springframework/ws/client/support/destination/Wsdl11DestinationProvider.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,7 @@ public void setWsdl(Resource wsdlResource) {
9191
* <p>
9292
* The expression can use the following bound prefixes: <blockquote>
9393
* <table>
94+
* <caption>Bound Prefixes</caption>
9495
* <tr>
9596
* <th>Prefix</th>
9697
* <th>Namespace</th>

spring-ws-core/src/main/java/org/springframework/ws/config/MarshallingEndpointsBeanDefinitionParser.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@
2525
import org.springframework.util.StringUtils;
2626

2727
/**
28-
* Parser for the <code>&lt;sws:marshalling-endpoints/&gt; element.
28+
* Parser for the {@code <sws:marshalling-endpoints/>} element.
2929
*
3030
* @author Arjen Poutsma
3131
* @since 1.5.0

spring-ws-core/src/main/java/org/springframework/ws/config/XPathEndpointsBeanDefinitionParser.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
import org.springframework.util.xml.DomUtils;
2828

2929
/**
30-
* Parser for the <code>&lt;sws:xpath-endpoints/&gt; element.
30+
* Parser for the {@code <sws:xpath-endpoints>} element.
3131
*
3232
* @author Arjen Poutsma
3333
* @since 1.5.0

spring-ws-core/src/main/java/org/springframework/ws/config/annotation/EnableWs.java

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -30,20 +30,19 @@
3030
* Web Services configuration defined in {@link WsConfigurationSupport} imported. For
3131
* instance:
3232
*
33-
* <pre class="code">
33+
* <pre><code class='java'>
3434
* &#064;Configuration
3535
* &#064;EnableWs
3636
* &#064;ComponentScan(basePackageClasses = { MyConfiguration.class })
3737
* public class MyWsConfiguration {
3838
*
39-
* }
40-
* </pre>
39+
* }</code></pre>
4140
* <p>
4241
* Customize the imported configuration by implementing the {@link WsConfigurer} interface
4342
* or more likely by extending the {@link WsConfigurerAdapter} base class and overriding
4443
* individual methods:
4544
*
46-
* <pre class="code">
45+
* <pre><code class='java'>
4746
* &#064;Configuration
4847
* &#064;EnableWs
4948
* &#064;ComponentScan(basePackageClasses = { MyConfiguration.class })
@@ -60,14 +59,13 @@
6059
* }
6160
*
6261
* // More overridden methods ...
63-
* }
64-
* </pre>
62+
* }</code></pre>
6563
* <p>
6664
* If the customization options of {@link WsConfigurer} do not expose something you need
6765
* to configure, consider removing the {@code @EnableWs} annotation and extending directly
6866
* from {@link WsConfigurationSupport} overriding selected {@code @Bean} methods:
6967
*
70-
* <pre class="code">
68+
* <pre><code class='java'>
7169
* &#064;Configuration
7270
* &#064;ComponentScan(basePackageClasses = { MyConfiguration.class })
7371
* public class MyConfiguration extends WsConfigurationSupport {
@@ -83,8 +81,7 @@
8381
* // Create or delegate to "super" to create and
8482
* // customize properties of DefaultMethodEndpointAdapter
8583
* }
86-
* }
87-
* </pre>
84+
* }</code></pre>
8885
*
8986
* @see WsConfigurer
9087
* @see WsConfigurerAdapter

spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/MarshallingMethodEndpointAdapter.java

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,10 @@
3333
* Adapter that supports endpoint methods that use marshalling. Supports methods with the
3434
* following signature:
3535
*
36-
* <pre>
37-
* void handleMyMessage(MyUnmarshalledType request);
38-
* </pre>
39-
*
40-
* or
41-
*
42-
* <pre>
43-
* MyMarshalledType handleMyMessage(MyUnmarshalledType request);
44-
* </pre>
36+
* <pre><code class='java'>
37+
* void handleMyMessage(MyUnmarshalledType request);</code></pre> or
38+
* <pre><code class='java'>
39+
* MyMarshalledType handleMyMessage(MyUnmarshalledType request);</code></pre>
4540
*
4641
* I.e. methods that take a single parameter that {@link Unmarshaller#supports(Class) is
4742
* supported} by the {@link Unmarshaller}, and return either {@code void} or a type

spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/MessageMethodEndpointAdapter.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,8 @@
2727
* Adapter that supports endpoint methods with message contexts. Supports methods with the
2828
* following signature:
2929
*
30-
* <pre>
31-
* void handleMyMessage(MessageContext request);
32-
* </pre>
30+
* <pre><code class='java'>
31+
* void handleMyMessage(MessageContext request);</code></pre>
3332
*
3433
* I.e. methods that take a single {@link MessageContext} parameter, and return
3534
* {@code void}. The method can have any name, as long as it is mapped by an

spring-ws-core/src/main/java/org/springframework/ws/server/endpoint/adapter/PayloadMethodEndpointAdapter.java

Lines changed: 6 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -28,21 +28,12 @@
2828

2929
/**
3030
* Adapter that supports endpoint methods that use marshalling. Supports methods with the
31-
* following signature:
32-
*
33-
* <pre>
34-
* void handleMyMessage(Source request);
35-
* </pre>
36-
*
37-
* or
38-
*
39-
* <pre>
40-
* Source handleMyMessage(Source request);
41-
* </pre>
42-
*
43-
* I.e. methods that take a single {@link Source} parameter, and return either
44-
* {@code void} or a {@link Source}. The method can have any name, as long as it is mapped
45-
* by an {@link org.springframework.ws.server.EndpointMapping}.
31+
* following signature: <pre><code class='java'>
32+
* void handleMyMessage(Source request);</code></pre> or <pre><code class='java'>
33+
* Source handleMyMessage(Source request);</code></pre> I.e. methods that take a single
34+
* {@link Source} parameter, and return either {@code void} or a {@link Source}. The
35+
* method can have any name, as long as it is mapped by an
36+
* {@link org.springframework.ws.server.EndpointMapping}.
4637
* <p>
4738
* This adapter is registered by default by the {@link MessageDispatcher} and
4839
* {@link SoapMessageDispatcher}.

0 commit comments

Comments
 (0)