Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix javadoc and reenable Javadoc doclint verification #1438

Merged
merged 2 commits into from
Feb 15, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -283,8 +283,6 @@
hljs.initHighlightingOnLoad();
</script>
]]></footer>
<!-- some jdk don't support nested li tags :( -->
<doclint>none</doclint>
</configuration>
</plugin>
</plugins>
Expand Down
3 changes: 2 additions & 1 deletion src/main/java/org/assertj/core/api/AbstractObjectAssert.java
Original file line number Diff line number Diff line change
Expand Up @@ -813,12 +813,13 @@ public <T> SELF returns(T expected, Function<ACTUAL, T> from) {
* <ul>
* <li>actual and expected objects and their fields were compared field by field recursively even if they were not of the same type, this allows for example to compare a Person to a PersonDto (call {@link RecursiveComparisonAssert#withStrictTypeChecking() withStrictTypeChecking()} to change that behavior). </li>
* <li>overridden equals methods were used in the comparison (unless stated otherwise)</li>
* <li>these types were compared with the following comparators: </li>
* <li>these types were compared with the following comparators:
* <ul>
* <li>java.lang.Double -&gt; DoubleComparator[precision=1.0E-15] </li>
* <li>java.lang.Float -&gt; FloatComparator[precision=1.0E-6] </li>
* <li>any comparators previously registered with {@link AbstractObjectAssert#usingComparatorForType(Comparator, Class)} </li>
* </ul>
* </li>
* </ul>
*
* @return a new {@link RecursiveComparisonAssert} instance
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -666,7 +666,7 @@ public SELF withComparatorForFields(Comparator<?> comparator, String... fieldLoc
* .withComparatorForType(closeEnough, Double.class)
* .isEqualTo(reallyTallFrodo);</code></pre>
*
* @param T the class type to register a comparator for
* @param <T> the class type to register a comparator for
* @param comparator the {@link java.util.Comparator Comparator} to use to compare the given fields
* @param type the type to be compared with the given comparator.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,7 @@ public void ignoreOverriddenEqualsForTypes(Class<?>... types) {
* <p>
* See {@link RecursiveComparisonAssert#withComparatorForType(Comparator, Class)} for examples.
*
* @param <T> the class type to register a comparator for
* @param comparator the {@link java.util.Comparator Comparator} to use to compare the given field
* @param type the type to be compared with the given comparator.
*/
Expand Down