Move the Javadoc overview where the Maven Javadoc plugin expects it

Update from Doxia 1 to 2
This commit is contained in:
Gary D. Gregory 2025-01-19 16:07:08 -05:00
parent 92f21ae630
commit 0ba032b6dc
2 changed files with 19 additions and 27 deletions

View File

@ -126,7 +126,7 @@
<commons.jacoco.branchRatio>0.78</commons.jacoco.branchRatio>
<commons.jacoco.lineRatio>0.85</commons.jacoco.lineRatio>
<commons.jacoco.complexityRatio>0.78</commons.jacoco.complexityRatio>
<doxia.module.markdown.version>1.12.0</doxia.module.markdown.version>
<doxia.module.markdown.version>2.0.0</doxia.module.markdown.version>
<math.mathjax.version>2.7.9</math.mathjax.version>
<commons.easymock.version>5.5.0</commons.easymock.version>
<!-- PMD 7.9.0 throws java.io.IOException: Stream closed probably because PMD is shadding ASM. -->

View File

@ -28,19 +28,20 @@
See also the {@code java.util} package for the standard Java collections.
</p>
<h4>Main features</h4>
<h1>Main features</h1>
<p>
Commons-Collections defines a number of key interfaces:
</p>
<table border="1" cellspacing="0" cellpadding="3">
<tr bgcolor="#CCCCFF" class="TableHeadingColor">
<table border="1">
<caption>Interfaces</caption>
<tr class="TableHeadingColor">
<th>Interface</th><th>Description</th>
</tr>
<tr>
<td>
{@link org.apache.commons.collections.Bag}
{@link org.apache.commons.collections4.Bag}
</td>
<td valign="top">
<td>
A new {@code Collection} subinterface that stores each object together
with the number of occurrences. Methods are provided to get the number of
occurrences, and to add and remove a certain number of that object.
@ -48,57 +49,48 @@
</tr>
<tr>
<td>
{@link org.apache.commons.collections.Buffer}
{@link org.apache.commons.collections4.BidiMap}
</td>
<td valign="top">
A new {@code Collection} subinterface that allows objects to be removed
in some well-defined order. Methods enable the next item to be peeked and removed.
</td>
</tr>
<tr>
<td>
{@link org.apache.commons.collections.BidiMap}
</td>
<td valign="top">
A new {@code Map} subinterface that allows lookup from key to value and
from value to key with equal ease.
</td>
</tr>
<tr>
<td>
{@link org.apache.commons.collections.OrderedMap}
{@link org.apache.commons.collections4.OrderedMap}
</td>
<td valign="top">
<td>
A new {@code Map} subinterface that is used when a map has an order, but is
not sorted. Methods enable bidirectional iteration through the map.
</td>
</tr>
<tr>
<td>
{@link org.apache.commons.collections.MapIterator}
{@link org.apache.commons.collections4.MapIterator}
</td>
<td valign="top">
<td>
A new {@code Iterator} subinterface specially designed for maps. This iterator
avoids the need for entrySet iteration of a map, and is simpler to use.
</td>
</tr>
<tr>
<td>
{@link org.apache.commons.collections.ResettableIterator}
{@link org.apache.commons.collections4.ResettableIterator}
</td>
<td valign="top">
<td>
A new {@code Iterator} subinterface that allows the iteration to be reset back
to the start. Many iterators in this library have this functionality.
</td>
</tr>
<tr>
<td>
{@link org.apache.commons.collections.Closure}<br />
{@link org.apache.commons.collections.Predicate}<br />
{@link org.apache.commons.collections.Transformer}<br />
{@link org.apache.commons.collections.Factory}<br />
{@link org.apache.commons.collections4.Closure}<br />
{@link org.apache.commons.collections4.Predicate}<br />
{@link org.apache.commons.collections4.Transformer}<br />
{@link org.apache.commons.collections4.Factory}<br />
</td>
<td valign="top">
<td>
A group of <i>functor</i> interfaces that provide plugin behavior to various
collections and utilities.
</td>