This is an automated email from the ASF dual-hosted git repository.
mgrigorov pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/wicket.git
The following commit(s) were added to refs/heads/master by this push:
new 270a5a4 Fix some more javadoc issues.
270a5a4 is described below
commit 270a5a43970cd975539331b21a34bd83a59c9c39
Author: Martin Tzvetanov Grigorov <[email protected]>
AuthorDate: Mon Aug 9 11:06:16 2021 +0300
Fix some more javadoc issues.
Re-disable javadoc 'missing' linter because there are many errors which I
didn't notice before.
---
pom.xml | 2 +-
.../java/org/apache/wicket/feedback/FeedbackMessagesModel.java | 1 -
.../src/main/java/org/apache/wicket/markup/html/form/Form.java | 4 ++--
.../org/apache/wicket/request/cycle/IRequestCycleListener.java | 5 ++---
.../wicket/request/cycle/RequestCycleListenerCollection.java | 8 ++++----
.../main/java/org/apache/wicket/settings/ResourceSettings.java | 2 --
.../src/test/java/org/apache/wicket/AttributeModifierTest.java | 4 ++--
.../src/main/java/org/apache/wicket/util/io/BOMInputStream.java | 9 ++++-----
8 files changed, 15 insertions(+), 20 deletions(-)
diff --git a/pom.xml b/pom.xml
index e89678f..6564ee5 100644
--- a/pom.xml
+++ b/pom.xml
@@ -1061,7 +1061,7 @@
</links>
<linksource>true</linksource>
<failOnError>true</failOnError>
- <doclint>all,-html</doclint>
+
<doclint>all,-html,-missing</doclint>
<additionalJOption>${javadoc.additionalJOption}</additionalJOption>
<source>8</source>
</configuration>
diff --git
a/wicket-core/src/main/java/org/apache/wicket/feedback/FeedbackMessagesModel.java
b/wicket-core/src/main/java/org/apache/wicket/feedback/FeedbackMessagesModel.java
index c056dee..5a2c086 100644
---
a/wicket-core/src/main/java/org/apache/wicket/feedback/FeedbackMessagesModel.java
+++
b/wicket-core/src/main/java/org/apache/wicket/feedback/FeedbackMessagesModel.java
@@ -194,7 +194,6 @@ public class FeedbackMessagesModel implements
IModel<List<FeedbackMessage>>
* See {@link FeedbackCollector#setIncludeSession} and {@link
Session#getFeedbackMessages}
*
* @param includeSession
- * @return
* @return {@code this} for chaining
*/
public FeedbackMessagesModel setIncludeSession(boolean includeSession)
diff --git
a/wicket-core/src/main/java/org/apache/wicket/markup/html/form/Form.java
b/wicket-core/src/main/java/org/apache/wicket/markup/html/form/Form.java
index 43d509c..249083c 100644
--- a/wicket-core/src/main/java/org/apache/wicket/markup/html/form/Form.java
+++ b/wicket-core/src/main/java/org/apache/wicket/markup/html/form/Form.java
@@ -1444,8 +1444,8 @@ public class Form<T> extends WebMarkupContainer
}
/**
- * Handles multi-part processing of the submitted data. <h3>
- * WARNING</h3> If this method is overridden it can break {@link
FileUploadField}s on this form
+ * Handles multi-part processing of the submitted data.
+ * <strong>WARNING</strong> If this method is overridden it can break
{@link FileUploadField}s on this form
*
* @return false if form is multipart and upload failed
*/
diff --git
a/wicket-core/src/main/java/org/apache/wicket/request/cycle/IRequestCycleListener.java
b/wicket-core/src/main/java/org/apache/wicket/request/cycle/IRequestCycleListener.java
index 1bb1a04..06cf42e 100644
---
a/wicket-core/src/main/java/org/apache/wicket/request/cycle/IRequestCycleListener.java
+++
b/wicket-core/src/main/java/org/apache/wicket/request/cycle/IRequestCycleListener.java
@@ -32,7 +32,7 @@ import org.apache.wicket.request.Url;
* <b>NOTE</b>: a listener implementation is a singleton and hence needs to
ensure proper handling
* of multi-threading issues.
* <p>
- * <h3>Call order</h3>
+ * Call order
* <p>
* The interface methods are ordered in the execution order as Wicket goes
through the request
* cycle:
@@ -53,8 +53,7 @@ import org.apache.wicket.request.Url;
* <li>{@link #onException(RequestCycle, Exception)}, followed by
* {@link #onExceptionRequestHandlerResolved(RequestCycle,
org.apache.wicket.request.IRequestHandler, Exception)} </li>
* </ul>
- *
- * <h3>Example</h3>
+ *
* <p>
* A short example of a request counter.
* </p>
diff --git
a/wicket-core/src/main/java/org/apache/wicket/request/cycle/RequestCycleListenerCollection.java
b/wicket-core/src/main/java/org/apache/wicket/request/cycle/RequestCycleListenerCollection.java
index 0434913..4e75528 100644
---
a/wicket-core/src/main/java/org/apache/wicket/request/cycle/RequestCycleListenerCollection.java
+++
b/wicket-core/src/main/java/org/apache/wicket/request/cycle/RequestCycleListenerCollection.java
@@ -29,16 +29,16 @@ import org.slf4j.LoggerFactory;
* Composite {@link IRequestCycleListener} that notifies all registered
listeners with each
* IRequestCycleListener event.
* <p>
- * <h3>Order of notification</h3>
- * <p>
+ * Order of notification
+ *
* {@link #onBeginRequest(RequestCycle)}, {@link
#onRequestHandlerScheduled(RequestCycle, IRequestHandler)} and
* {@link #onRequestHandlerResolved(RequestCycle, IRequestHandler)} are
notified in first in, first out order.
* <p>
* {@link #onEndRequest(RequestCycle)} and {@link #onDetach(RequestCycle)} are
notified in last in
* first out order (i.e. reversed order). So for these events the collection
functions as a stack.
* <p>
- * <h3>Exception handling</h3>
- * <p>
+ * Exception handling
+ *
* The {@code RequestCycleListenerCollection} will use the first exception
handler that is returned
* from all listeners in {@link #onException(RequestCycle, Exception)}
*/
diff --git
a/wicket-core/src/main/java/org/apache/wicket/settings/ResourceSettings.java
b/wicket-core/src/main/java/org/apache/wicket/settings/ResourceSettings.java
index def2d11..9c56ce1 100644
--- a/wicket-core/src/main/java/org/apache/wicket/settings/ResourceSettings.java
+++ b/wicket-core/src/main/java/org/apache/wicket/settings/ResourceSettings.java
@@ -562,7 +562,6 @@ public class ResourceSettings implements
IPropertiesFactoryContext
* @param compressor
* The implementation to be used
* @return The old value
- * @return {@code this} object for chaining
*/
public IJavaScriptCompressor
setJavaScriptCompressor(IJavaScriptCompressor compressor)
{
@@ -592,7 +591,6 @@ public class ResourceSettings implements
IPropertiesFactoryContext
* @param compressor
* The implementation to be used
* @return The old value
- * @return {@code this} object for chaining
*/
public ICssCompressor setCssCompressor(ICssCompressor compressor)
{
diff --git
a/wicket-core/src/test/java/org/apache/wicket/AttributeModifierTest.java
b/wicket-core/src/test/java/org/apache/wicket/AttributeModifierTest.java
index a01ff29..927933b 100644
--- a/wicket-core/src/test/java/org/apache/wicket/AttributeModifierTest.java
+++ b/wicket-core/src/test/java/org/apache/wicket/AttributeModifierTest.java
@@ -347,7 +347,7 @@ class AttributeModifierTest
AttributeModifier appender = AttributeModifier.append("class",
AttributeModifier.VALUELESS_ATTRIBUTE_ADD);
final AttributeModifier copy =
WicketObjects.cloneObject(appender);
final IModel<?> replaceModel = copy.getReplaceModel();
-
assertThat(replaceModel.getObject()).isEqualToComparingFieldByField(AttributeModifier.VALUELESS_ATTRIBUTE_ADD);
+
assertThat(replaceModel.getObject()).usingRecursiveComparison().isEqualTo(AttributeModifier.VALUELESS_ATTRIBUTE_ADD);
}
@@ -360,6 +360,6 @@ class AttributeModifierTest
AttributeModifier appender = AttributeModifier.append("class",
AttributeModifier.VALUELESS_ATTRIBUTE_REMOVE);
final AttributeModifier copy =
WicketObjects.cloneObject(appender);
final IModel<?> replaceModel = copy.getReplaceModel();
-
assertThat(replaceModel.getObject()).isEqualToComparingFieldByField(AttributeModifier.VALUELESS_ATTRIBUTE_REMOVE);
+
assertThat(replaceModel.getObject()).usingRecursiveComparison().isEqualTo(AttributeModifier.VALUELESS_ATTRIBUTE_REMOVE);
}
}
diff --git
a/wicket-util/src/main/java/org/apache/wicket/util/io/BOMInputStream.java
b/wicket-util/src/main/java/org/apache/wicket/util/io/BOMInputStream.java
index 6762721..9461ebd 100644
--- a/wicket-util/src/main/java/org/apache/wicket/util/io/BOMInputStream.java
+++ b/wicket-util/src/main/java/org/apache/wicket/util/io/BOMInputStream.java
@@ -36,9 +36,8 @@ import java.util.List;
* <li>UTF-32BE - {@link ByteOrderMark#UTF_32LE}</li>
* <li>UTF-32LE - {@link ByteOrderMark#UTF_32BE}</li>
* </ul>
- *
- *
- * <h3>Example 1 - Detect and exclude a UTF-8 BOM</h3>
+ *
+ * <p> Example 1 - Detect and exclude a UTF-8 BOM
*
* <pre>
* BOMInputStream bomIn = new BOMInputStream(in);
@@ -47,7 +46,7 @@ import java.util.List;
* }
* </pre>
*
- * <h3>Example 2 - Detect a UTF-8 BOM (but don't exclude it)</h3>
+ * <p> Example 2 - Detect a UTF-8 BOM (but don't exclude it)
*
* <pre>
* boolean include = true;
@@ -57,7 +56,7 @@ import java.util.List;
* }
* </pre>
*
- * <h3>Example 3 - Detect Multiple BOMs</h3>
+ * <p> Example 3 - Detect Multiple BOMs
*
* <pre>
* BOMInputStream bomIn = new BOMInputStream(in,
