This is an automated email from the ASF dual-hosted git repository. reschke pushed a commit to branch OAK-11650 in repository https://gitbox.apache.org/repos/asf/jackrabbit-oak.git
commit 220667ec8cc020ae3bdc238fc0b33ca5d50514f6 Author: Julian Reschke <[email protected]> AuthorDate: Thu Apr 10 08:27:33 2025 +0100 OAK-11650: Fix Javadoc errors - </p> --- .../oak/benchmark/LucenePropertyFTIndexedContentAvailability.java | 4 ---- .../apache/jackrabbit/oak/commons/concurrent/ExecutorCloser.java | 2 -- .../apache/jackrabbit/oak/commons/collections/SetUtilsTest.java | 1 - .../apache/jackrabbit/oak/plugins/atomic/AtomicCounterEditor.java | 7 ------- .../jackrabbit/oak/plugins/index/property/PropertyIndex.java | 3 --- .../apache/jackrabbit/oak/plugins/version/VersionableState.java | 1 - .../oak/security/authorization/restriction/GlobPattern.java | 3 --- .../main/java/org/apache/lucene/codecs/BlockTreeTermsWriter.java | 1 - .../org/apache/lucene/codecs/lucene40/Lucene40DocValuesFormat.java | 1 - .../apache/lucene/codecs/lucene40/Lucene40FieldInfosFormat.java | 1 - .../org/apache/lucene/codecs/lucene40/Lucene40PostingsFormat.java | 3 --- .../apache/lucene/codecs/lucene40/Lucene40SegmentInfoFormat.java | 3 --- .../org/apache/lucene/codecs/lucene41/Lucene41PostingsFormat.java | 4 ---- .../apache/lucene/codecs/lucene42/Lucene42FieldInfosFormat.java | 1 - .../apache/lucene/codecs/lucene46/Lucene46FieldInfosFormat.java | 1 - .../apache/lucene/codecs/lucene46/Lucene46SegmentInfoFormat.java | 3 --- .../src/main/java/org/apache/lucene/index/AutomatonTermsEnum.java | 1 - .../java/org/apache/lucene/index/DocumentsWriterPerThreadPool.java | 1 - oak-lucene/src/main/java/org/apache/lucene/index/SegmentInfos.java | 4 ---- .../src/main/java/org/apache/lucene/search/AutomatonQuery.java | 2 -- .../src/main/java/org/apache/lucene/search/NumericRangeQuery.java | 3 --- oak-lucene/src/main/java/org/apache/lucene/search/RegexpQuery.java | 1 - oak-lucene/src/main/java/org/apache/lucene/search/Scorer.java | 2 -- .../java/org/apache/lucene/search/similarities/IBSimilarity.java | 1 - .../apache/lucene/search/similarities/LMDirichletSimilarity.java | 1 - .../src/main/java/org/apache/lucene/store/MMapDirectory.java | 1 - .../src/main/java/org/apache/lucene/store/NIOFSDirectory.java | 2 -- oak-lucene/src/main/java/org/apache/lucene/util/BytesRefHash.java | 1 - .../main/java/org/apache/lucene/util/FieldCacheSanityChecker.java | 2 -- .../java/org/apache/lucene/util/RecyclingByteBlockAllocator.java | 1 - .../java/org/apache/lucene/util/RecyclingIntBlockAllocator.java | 1 - .../src/main/java/org/apache/lucene/util/automaton/Automaton.java | 1 - .../jackrabbit/oak/spi/security/user/action/GroupAction.java | 2 -- .../apache/jackrabbit/oak/spi/security/user/action/UserAction.java | 1 - .../org/apache/jackrabbit/oak/segment/CacheWeightEstimator.java | 2 -- .../org/apache/jackrabbit/oak/segment/SegmentCompactionIT.java | 1 - .../apache/jackrabbit/oak/segment/SegmentOverflowExceptionIT.java | 2 -- .../jackrabbit/oak/segment/file/LargeNumberOfPropertiesTestIT.java | 1 - .../jackrabbit/oak/segment/file/SegmentReferenceLimitTestIT.java | 1 - 39 files changed, 74 deletions(-) diff --git a/oak-benchmarks-lucene/src/main/java/org/apache/jackrabbit/oak/benchmark/LucenePropertyFTIndexedContentAvailability.java b/oak-benchmarks-lucene/src/main/java/org/apache/jackrabbit/oak/benchmark/LucenePropertyFTIndexedContentAvailability.java index 3f8aaa184b..0630c1d27a 100644 --- a/oak-benchmarks-lucene/src/main/java/org/apache/jackrabbit/oak/benchmark/LucenePropertyFTIndexedContentAvailability.java +++ b/oak-benchmarks-lucene/src/main/java/org/apache/jackrabbit/oak/benchmark/LucenePropertyFTIndexedContentAvailability.java @@ -39,14 +39,11 @@ import org.slf4j.LoggerFactory; * Perform a benchmark on how long it takes for an ingested item to be available in a Lucene * Property index when indexed in conjunction with a Global full-text lucene (same thread). It makes * use of the {@link WikipediaImport} to use a Wikipedia dump for content injestion. - * </p> * <p> * Suggested dump: * <a href="https://dumps.wikimedia.org/enwiki/20150403/enwiki-20150403-pages-articles.xml.bz2";>https://dumps.wikimedia.org/enwiki/20150403/enwiki-20150403-pages-articles.xml.bz2</a> - * </p> * <p> * Usage example: - * </p> * * <pre> * java -Druntime=900 -Dlogback.configurationFile=logback-benchmark.xml \ @@ -56,7 +53,6 @@ import org.slf4j.LoggerFactory; * </pre> * <p> * it will run the benchmark for 15 minutes against TarNS and MongoNS. - * </p> */ public class LucenePropertyFTIndexedContentAvailability extends PropertyFullTextTest { private static final Logger LOG = LoggerFactory.getLogger(LucenePropertyFTIndexedContentAvailability.class); diff --git a/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/concurrent/ExecutorCloser.java b/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/concurrent/ExecutorCloser.java index 5aebcfe20e..dff4f1f07f 100644 --- a/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/concurrent/ExecutorCloser.java +++ b/oak-commons/src/main/java/org/apache/jackrabbit/oak/commons/concurrent/ExecutorCloser.java @@ -30,12 +30,10 @@ import org.slf4j.LoggerFactory; /** * <p> * Utility class to properly close any ExecutorService. - * </p> * * <p> * It will attempt a graceful close within the provided timeout. If after such any of the contained * tasks are not terminated yet, it will force a shutdown and track a warning in the logs. - * </p> * */ public final class ExecutorCloser implements Closeable { diff --git a/oak-commons/src/test/java/org/apache/jackrabbit/oak/commons/collections/SetUtilsTest.java b/oak-commons/src/test/java/org/apache/jackrabbit/oak/commons/collections/SetUtilsTest.java index 9bc6ecd46e..ec74d7c311 100644 --- a/oak-commons/src/test/java/org/apache/jackrabbit/oak/commons/collections/SetUtilsTest.java +++ b/oak-commons/src/test/java/org/apache/jackrabbit/oak/commons/collections/SetUtilsTest.java @@ -38,7 +38,6 @@ import static org.junit.Assert.fail; * <p> * This class contains test cases to verify the functionality of the methods * in the {@link SetUtils} class. - * </p> */ public class SetUtilsTest { diff --git a/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/atomic/AtomicCounterEditor.java b/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/atomic/AtomicCounterEditor.java index c66705c687..3397723754 100644 --- a/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/atomic/AtomicCounterEditor.java +++ b/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/atomic/AtomicCounterEditor.java @@ -58,7 +58,6 @@ import org.slf4j.LoggerFactory; * Manages a node as <em>Atomic Counter</em>: a node which will handle at low level a protected * property ({@link #PROP_COUNTER}) in an atomic way. This will represent an increment or decrement * of a counter in the case, for example, of <em>Likes</em> or <em>Voting</em>. - * </p> * * <p> * Whenever you add a {@link NodeTypeConstants#MIX_ATOMIC_COUNTER} mixin to a node it will turn it @@ -66,11 +65,9 @@ import org.slf4j.LoggerFactory; * you'll need to set the {@code oak:increment} one ({@link #PROP_INCREMENT}). Please note that the * <strong>{@code oak:incremement} will never be saved</strong>, only the {@code oak:counter} will * be amended accordingly. - * </p> * * <p> * So in order to deal with the counter from a JCR point of view you'll do something as follows - * </p> * * <pre> * Session session = ... @@ -106,25 +103,21 @@ import org.slf4j.LoggerFactory; * The related jira ticket is <a href="https://issues.apache.org/jira/browse/OAK-2472";>OAK-2472</a>. * In a nutshell when you save an {@code oak:increment} behind the scene it takes its value and * increment an internal counter. There will be an individual counter for each cluster node. - * </p> * * <p> * Then it will consolidate all the internal counters into a single one: {@code oak:counter}. The * consolidation process can happen either synchronously or asynchronously. Refer to * {@link #AtomicCounterEditor(NodeBuilder, String, ScheduledExecutorService, NodeStore, Whiteboard)} * for details on when it consolidate one way or the other. - * </p> * * <p> * <strong>synchronous</strong>. It means the consolidation, sum of all the internal counters, will * happen in the same thread. During the lifecycle of the same commit. - * </p> * * <p> * <strong>asynchronous</strong>. It means the internal counters will be set during the same commit; * but it will eventually schedule a separate thread in which will retry some times to consolidate * them. - * </p> */ public class AtomicCounterEditor extends DefaultEditor { /** diff --git a/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/index/property/PropertyIndex.java b/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/index/property/PropertyIndex.java index cf9b5b47a4..b205cb2db0 100644 --- a/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/index/property/PropertyIndex.java +++ b/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/index/property/PropertyIndex.java @@ -49,21 +49,18 @@ import org.slf4j.LoggerFactory; * <li>must have the <code>type</code> property set to <b><code>property</code></b></li> * <li>contains the <code>propertyNames</code> property that indicates what property will be stored in the index</li> * </ul> - * </p> * <p> * Optionally you can specify * <ul> * <li> a uniqueness constraint on a property index by setting the <code>unique</code> flag to <code>true</code></li> * <li> that the property index only applies to a certain node type by setting the <code>declaringNodeTypes</code> property</li> * </ul> - * </p> * <p> * Notes: * <ul> * <li> <code>propertyNames</code> can be a list of properties, and it is optional.in case it is missing, the node name will be used as a property name reference value</li> * <li> <code>reindex</code> is a property that when set to <code>true</code>, triggers a full content reindex.</li> * </ul> - * </p> * * <pre> * <code> diff --git a/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/version/VersionableState.java b/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/version/VersionableState.java index 39d0174b48..86d72d2465 100644 --- a/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/version/VersionableState.java +++ b/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/version/VersionableState.java @@ -84,7 +84,6 @@ import org.slf4j.LoggerFactory; * flag. It is expected that this is handled on a higher level. If this is not * done the uniqueness constraint on the jcr:uuid will kick in and fail the * commit. - * </p> */ class VersionableState { diff --git a/oak-core/src/main/java/org/apache/jackrabbit/oak/security/authorization/restriction/GlobPattern.java b/oak-core/src/main/java/org/apache/jackrabbit/oak/security/authorization/restriction/GlobPattern.java index 1ddcc0a781..b64e881d89 100644 --- a/oak-core/src/main/java/org/apache/jackrabbit/oak/security/authorization/restriction/GlobPattern.java +++ b/oak-core/src/main/java/org/apache/jackrabbit/oak/security/authorization/restriction/GlobPattern.java @@ -46,7 +46,6 @@ import static java.util.Objects.requireNonNull; * /foo | null | matches /foo and all descendants of /foo * /foo | "" | matches /foo only (no descendants, not even properties) * </pre> - * </p> * * <p> * Examples without wildcard char: @@ -59,7 +58,6 @@ import static java.util.Objects.requireNonNull; * cat | '/foocat' and all it's descendants * cat/ | all descendants of '/foocat' * </pre> - * </p> * * <p> * Examples including wildcard char: @@ -78,7 +76,6 @@ import static java.util.Objects.requireNonNull; * *cat/* | all siblings and descendants of foo that have an intermediate segment ending with 'cat' * /*cat/* | all descendants of /foo that have an intermediate segment ending with 'cat' * </pre> - * </p> */ final class GlobPattern implements RestrictionPattern { diff --git a/oak-lucene/src/main/java/org/apache/lucene/codecs/BlockTreeTermsWriter.java b/oak-lucene/src/main/java/org/apache/lucene/codecs/BlockTreeTermsWriter.java index 5842ed9396..9214d21252 100644 --- a/oak-lucene/src/main/java/org/apache/lucene/codecs/BlockTreeTermsWriter.java +++ b/oak-lucene/src/main/java/org/apache/lucene/codecs/BlockTreeTermsWriter.java @@ -100,7 +100,6 @@ import org.apache.lucene.util.packed.PackedInts; * field along with per-term statistics (such as docfreq) * and per-term metadata (typically pointers to the postings list * for that term in the inverted index). - * </p> * * <p>The .tim is arranged in blocks: with blocks containing * a variable number of entries (by default 25-48), where diff --git a/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene40/Lucene40DocValuesFormat.java b/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene40/Lucene40DocValuesFormat.java index 1926f1acee..02a98cf0fc 100644 --- a/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene40/Lucene40DocValuesFormat.java +++ b/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene40/Lucene40DocValuesFormat.java @@ -57,7 +57,6 @@ import org.apache.lucene.util.packed.PackedInts; * entries within the compound file. In the case of dereferenced/sorted types, the <tt>.dat</tt> * actually contains only the unique values, and an additional <tt>.idx</tt> file contains * pointers to these unique values. - * </p> * Formats: * <ul> * <li>{@code VAR_INTS} .dat --> Header, PackedType, MinValue, diff --git a/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene40/Lucene40FieldInfosFormat.java b/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene40/Lucene40FieldInfosFormat.java index d99267ae43..e2c9c76763 100644 --- a/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene40/Lucene40FieldInfosFormat.java +++ b/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene40/Lucene40FieldInfosFormat.java @@ -48,7 +48,6 @@ import org.apache.lucene.store.DataOutput; // javadoc * <li>FieldNumber --> {@link DataOutput#writeInt VInt}</li> * <li>Attributes --> {@link DataOutput#writeStringStringMap Map<String,String>}</li> * </ul> - * </p> * Field Descriptions: * <ul> * <li>FieldsCount: the number of fields in this file.</li> diff --git a/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene40/Lucene40PostingsFormat.java b/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene40/Lucene40PostingsFormat.java index cb2c5ceea1..e389d5448e 100644 --- a/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene40/Lucene40PostingsFormat.java +++ b/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene40/Lucene40PostingsFormat.java @@ -53,7 +53,6 @@ import org.apache.lucene.util.fst.FST; // javadocs * <li><tt>.frq</tt>: <a href="#Frequencies">Frequencies</a></li> * <li><tt>.prx</tt>: <a href="#Positions">Positions</a></li> * </ul> - * </p> * <p> * <a name="Termdictionary" id="Termdictionary"></a> * <h3>Term Dictionary</h3> @@ -63,7 +62,6 @@ import org.apache.lucene.util.fst.FST; // javadocs * and pointers to the frequencies, positions and * skip data in the .frq and .prx files. * See {@link BlockTreeTermsWriter} for more details on the format. - * </p> * * <p>NOTE: The term dictionary can plug into different postings implementations: * the postings writer/reader are actually responsible for encoding @@ -180,7 +178,6 @@ import org.apache.lucene.util.fst.FST; // javadocs * referencing the corresponding SkipData entry in level-1. In the example has * entry 15 on level 1 a pointer to entry 15 on level 0 and entry 31 on level 1 a * pointer to entry 31 on level 0. - * </p> * <a name="Positions" id="Positions"></a> * <h3>Positions</h3> * <p>The .prx file contains the lists of positions that each term occurs at diff --git a/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene40/Lucene40SegmentInfoFormat.java b/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene40/Lucene40SegmentInfoFormat.java index 25a9bab927..07cb7de2e0 100644 --- a/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene40/Lucene40SegmentInfoFormat.java +++ b/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene40/Lucene40SegmentInfoFormat.java @@ -41,7 +41,6 @@ import org.apache.lucene.store.DataOutput; // javadocs * <ul> * <li><tt>.si</tt>: Header, SegVersion, SegSize, IsCompoundFile, Diagnostics, Attributes, Files * </ul> - * </p> * Data types: * <p> * <ul> @@ -52,7 +51,6 @@ import org.apache.lucene.store.DataOutput; // javadocs * <li>Diagnostics, Attributes --> {@link DataOutput#writeStringStringMap Map<String,String>}</li> * <li>IsCompoundFile --> {@link DataOutput#writeByte Int8}</li> * </ul> - * </p> * Field Descriptions: * <p> * <ul> @@ -71,7 +69,6 @@ import org.apache.lucene.store.DataOutput; // javadocs * <li>Attributes: a key-value map of codec-private attributes.</li> * <li>Files is a list of files referred to by this segment.</li> * </ul> - * </p> * * @see SegmentInfos * @lucene.experimental diff --git a/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene41/Lucene41PostingsFormat.java b/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene41/Lucene41PostingsFormat.java index 9b2fd0f0e8..e88d0ee223 100644 --- a/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene41/Lucene41PostingsFormat.java +++ b/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene41/Lucene41PostingsFormat.java @@ -104,7 +104,6 @@ import org.apache.lucene.util.packed.PackedInts; * this reduces disk pre-fetches.</p> * </li> * </ul> - * </p> * * <p> * Files and detailed format: @@ -115,7 +114,6 @@ import org.apache.lucene.util.packed.PackedInts; * <li><tt>.pos</tt>: <a href="#Positions">Positions</a></li> * <li><tt>.pay</tt>: <a href="#Payloads">Payloads and Offsets</a></li> * </ul> - * </p> * * <a name="Termdictionary" id="Termdictionary"></a> * <dl> @@ -127,7 +125,6 @@ import org.apache.lucene.util.packed.PackedInts; * and pointers to the frequencies, positions, payload and * skip data in the .doc, .pos, and .pay files. * See {@link BlockTreeTermsWriter} for more details on the format. - * </p> * * <p>NOTE: The term dictionary can plug into different postings implementations: * the postings writer/reader are actually responsible for encoding @@ -357,7 +354,6 @@ import org.apache.lucene.util.packed.PackedInts; * </ul> * </dd> * </dl> - * </p> * * @lucene.experimental */ diff --git a/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene42/Lucene42FieldInfosFormat.java b/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene42/Lucene42FieldInfosFormat.java index 5e4ce549f7..e3f00e9e38 100644 --- a/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene42/Lucene42FieldInfosFormat.java +++ b/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene42/Lucene42FieldInfosFormat.java @@ -49,7 +49,6 @@ import org.apache.lucene.store.DataOutput; // javadoc * <li>FieldNumber --> {@link DataOutput#writeInt VInt}</li> * <li>Attributes --> {@link DataOutput#writeStringStringMap Map<String,String>}</li> * </ul> - * </p> * Field Descriptions: * <ul> * <li>FieldsCount: the number of fields in this file.</li> diff --git a/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene46/Lucene46FieldInfosFormat.java b/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene46/Lucene46FieldInfosFormat.java index 18d5fc9f28..ce4cdbcf00 100755 --- a/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene46/Lucene46FieldInfosFormat.java +++ b/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene46/Lucene46FieldInfosFormat.java @@ -51,7 +51,6 @@ import org.apache.lucene.store.DataOutput; * <li>Attributes --> {@link DataOutput#writeStringStringMap Map<String,String>}</li> * <li>DocValuesGen --> {@link DataOutput#writeLong(long) Int64}</li> * </ul> - * </p> * Field Descriptions: * <ul> * <li>FieldsCount: the number of fields in this file.</li> diff --git a/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene46/Lucene46SegmentInfoFormat.java b/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene46/Lucene46SegmentInfoFormat.java index aa83d3a504..2d034adf0a 100755 --- a/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene46/Lucene46SegmentInfoFormat.java +++ b/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene46/Lucene46SegmentInfoFormat.java @@ -41,7 +41,6 @@ import org.apache.lucene.store.DataOutput; // javadocs * <ul> * <li><tt>.si</tt>: Header, SegVersion, SegSize, IsCompoundFile, Diagnostics, Files * </ul> - * </p> * Data types: * <p> * <ul> @@ -52,7 +51,6 @@ import org.apache.lucene.store.DataOutput; // javadocs * <li>Diagnostics --> {@link DataOutput#writeStringStringMap Map<String,String>}</li> * <li>IsCompoundFile --> {@link DataOutput#writeByte Int8}</li> * </ul> - * </p> * Field Descriptions: * <p> * <ul> @@ -70,7 +68,6 @@ import org.apache.lucene.store.DataOutput; // javadocs * addIndexes), etc.</li> * <li>Files is a list of files referred to by this segment.</li> * </ul> - * </p> * * @see SegmentInfos * @lucene.experimental diff --git a/oak-lucene/src/main/java/org/apache/lucene/index/AutomatonTermsEnum.java b/oak-lucene/src/main/java/org/apache/lucene/index/AutomatonTermsEnum.java index 012eb1d3f1..dae0ca804b 100644 --- a/oak-lucene/src/main/java/org/apache/lucene/index/AutomatonTermsEnum.java +++ b/oak-lucene/src/main/java/org/apache/lucene/index/AutomatonTermsEnum.java @@ -49,7 +49,6 @@ import org.apache.lucene.util.automaton.Transition; * The algorithm does not attempt to actually skip to the next string that is * completely accepted. This is not possible when the language accepted by the * FSM is not finite (i.e. * operator). - * </p> * @lucene.experimental */ class AutomatonTermsEnum extends FilteredTermsEnum { diff --git a/oak-lucene/src/main/java/org/apache/lucene/index/DocumentsWriterPerThreadPool.java b/oak-lucene/src/main/java/org/apache/lucene/index/DocumentsWriterPerThreadPool.java index be2147e3f6..0649a59862 100644 --- a/oak-lucene/src/main/java/org/apache/lucene/index/DocumentsWriterPerThreadPool.java +++ b/oak-lucene/src/main/java/org/apache/lucene/index/DocumentsWriterPerThreadPool.java @@ -42,7 +42,6 @@ import org.apache.lucene.util.SetOnce; * Once a {@link DocumentsWriterPerThread} is selected for flush the thread pool * is reusing the flushing {@link DocumentsWriterPerThread}s ThreadState with a * new {@link DocumentsWriterPerThread} instance. - * </p> */ abstract class DocumentsWriterPerThreadPool implements Cloneable { diff --git a/oak-lucene/src/main/java/org/apache/lucene/index/SegmentInfos.java b/oak-lucene/src/main/java/org/apache/lucene/index/SegmentInfos.java index ed5aa9d11e..93a1a791ee 100644 --- a/oak-lucene/src/main/java/org/apache/lucene/index/SegmentInfos.java +++ b/oak-lucene/src/main/java/org/apache/lucene/index/SegmentInfos.java @@ -69,7 +69,6 @@ import org.apache.lucene.util.StringHelper; * {@link org.apache.lucene.index.IndexDeletionPolicy IndexDeletionPolicy} * is in use). This file lists each segment by name and has details about the * codec and generation of deletes. - * </p> * <p>There is also a file <tt>segments.gen</tt>. This file contains * the current generation (the <tt>_N</tt> in <tt>segments_N</tt>) of the index. * This is used only as a fallback in case the current generation cannot be @@ -86,7 +85,6 @@ import org.apache.lucene.util.StringHelper; * <SegName, SegCodec, DelGen, DeletionCount, FieldInfosGen, UpdatesFiles><sup>SegCount</sup>, * CommitUserData, Checksum * </ul> - * </p> * Data types: * <p> * <ul> @@ -97,7 +95,6 @@ import org.apache.lucene.util.StringHelper; * <li>CommitUserData --> {@link DataOutput#writeStringStringMap Map<String,String>}</li> * <li>UpdatesFiles --> {@link DataOutput#writeStringSet(Set) Set<String>}</li> * </ul> - * </p> * Field Descriptions: * <p> * <ul> @@ -123,7 +120,6 @@ import org.apache.lucene.util.StringHelper; * means there are updates to fieldInfos stored by {@link FieldInfosFormat}.</li> * <li>UpdatesFiles stores the list of files that were updated in that segment.</li> * </ul> - * </p> * * @lucene.experimental */ diff --git a/oak-lucene/src/main/java/org/apache/lucene/search/AutomatonQuery.java b/oak-lucene/src/main/java/org/apache/lucene/search/AutomatonQuery.java index ea45dfc914..4a63f4fcab 100644 --- a/oak-lucene/src/main/java/org/apache/lucene/search/AutomatonQuery.java +++ b/oak-lucene/src/main/java/org/apache/lucene/search/AutomatonQuery.java @@ -43,14 +43,12 @@ import org.apache.lucene.util.automaton.CompiledAutomaton; * {@link org.apache.lucene.util.automaton} API. Alternatively, it can be * created from a regular expression with {@link RegexpQuery} or from * the standard Lucene wildcard syntax with {@link WildcardQuery}. - * </p> * <p> * When the query is executed, it will create an equivalent DFA of the * finite-state machine, and will enumerate the term dictionary in an * intelligent way to reduce the number of comparisons. For example: the regular * expression of <code>[dl]og?</code> will make approximately four comparisons: * do, dog, lo, and log. - * </p> * @lucene.experimental */ public class AutomatonQuery extends MultiTermQuery { diff --git a/oak-lucene/src/main/java/org/apache/lucene/search/NumericRangeQuery.java b/oak-lucene/src/main/java/org/apache/lucene/search/NumericRangeQuery.java index 45fdebb44f..53755f27b4 100644 --- a/oak-lucene/src/main/java/org/apache/lucene/search/NumericRangeQuery.java +++ b/oak-lucene/src/main/java/org/apache/lucene/search/NumericRangeQuery.java @@ -124,7 +124,6 @@ import org.apache.lucene.index.Term; // for javadocs * of indexed terms per value is (those are generated by {@link NumericTokenStream}): * <p style="font-family:serif"> * indexedTermsPerValue = <b>ceil</b><big>(</big>bitsPerValue / precisionStep<big>)</big> - * </p> * As the lower precision terms are shared by many values, the additional terms only * slightly grow the term dictionary (approx. 7% for <code>precisionStep=4</code>), but have a larger * impact on the postings (the postings file will have more entries, as every document is linked to @@ -133,14 +132,12 @@ import org.apache.lucene.index.Term; // for javadocs * <p> * <!-- the formula in the alt attribute was transformed from latex to PNG with http://1.618034.com/latex.php (with 110 dpi): --> * <img src="doc-files/nrq-formula-1.png" alt="\mathrm{termDictOverhead} = \sum\limits_{i=0}^{\mathrm{indexedTermsPerValue}-1} \frac{1}{2^{\mathrm{precisionStep}\cdot i}}" /> - * </p> * <p>On the other hand, if the <code>precisionStep</code> is smaller, the maximum number of terms to match reduces, * which optimizes query speed. The formula to calculate the maximum number of terms that will be visited while * executing the query is: * <p> * <!-- the formula in the alt attribute was transformed from latex to PNG with http://1.618034.com/latex.php (with 110 dpi): --> * <img src="doc-files/nrq-formula-2.png" alt="\mathrm{maxQueryTerms} = \left[ \left( \mathrm{indexedTermsPerValue} - 1 \right) \cdot \left(2^\mathrm{precisionStep} - 1 \right) \cdot 2 \right] + \left( 2^\mathrm{precisionStep} - 1 \right)" /> - * </p> * <p>For longs stored using a precision step of 4, <code>maxQueryTerms = 15*15*2 + 15 = 465</code>, and for a precision * step of 2, <code>maxQueryTerms = 31*3*2 + 3 = 189</code>. But the faster search speed is reduced by more seeking * in the term enum of the index. Because of this, the ideal <code>precisionStep</code> value can only diff --git a/oak-lucene/src/main/java/org/apache/lucene/search/RegexpQuery.java b/oak-lucene/src/main/java/org/apache/lucene/search/RegexpQuery.java index 967326c4cc..2c7937d94c 100644 --- a/oak-lucene/src/main/java/org/apache/lucene/search/RegexpQuery.java +++ b/oak-lucene/src/main/java/org/apache/lucene/search/RegexpQuery.java @@ -45,7 +45,6 @@ import org.apache.lucene.util.automaton.RegExp; * The supported syntax is documented in the {@link RegExp} class. * Note this might be different than other regular expression implementations. * For some alternatives with different syntax, look under the sandbox. - * </p> * <p> * Note this query can be slow, as it needs to iterate over many terms. In order * to prevent extremely slow RegexpQueries, a Regexp term should not start with diff --git a/oak-lucene/src/main/java/org/apache/lucene/search/Scorer.java b/oak-lucene/src/main/java/org/apache/lucene/search/Scorer.java index 7f9bc1b2c7..cb5811bfc9 100644 --- a/oak-lucene/src/main/java/org/apache/lucene/search/Scorer.java +++ b/oak-lucene/src/main/java/org/apache/lucene/search/Scorer.java @@ -37,11 +37,9 @@ import org.apache.lucene.index.DocsEnum; * <p> * A <code>Scorer</code> iterates over documents matching a * query in increasing order of doc Id. - * </p> * <p> * Document scores are computed using a given <code>Similarity</code> * implementation. - * </p> * * <p><b>NOTE</b>: The values Float.Nan, * Float.NEGATIVE_INFINITY and Float.POSITIVE_INFINITY are diff --git a/oak-lucene/src/main/java/org/apache/lucene/search/similarities/IBSimilarity.java b/oak-lucene/src/main/java/org/apache/lucene/search/similarities/IBSimilarity.java index 5a241962b2..7a371966c9 100644 --- a/oak-lucene/src/main/java/org/apache/lucene/search/similarities/IBSimilarity.java +++ b/oak-lucene/src/main/java/org/apache/lucene/search/similarities/IBSimilarity.java @@ -44,7 +44,6 @@ import org.apache.lucene.search.similarities.Normalization.NoNormalization; * <li><em>t<sup>d</sup><sub>w</sub></em> is the normalized term frequency;</li> * <li><em>λ<sub>w</sub></em> is a parameter.</li> * </ul> - * </p> * <p>The framework described in the paper has many similarities to the DFR * framework (see {@link DFRSimilarity}). It is possible that the two * Similarities will be merged at one point.</p> diff --git a/oak-lucene/src/main/java/org/apache/lucene/search/similarities/LMDirichletSimilarity.java b/oak-lucene/src/main/java/org/apache/lucene/search/similarities/LMDirichletSimilarity.java index e6075d2d4d..1273671d9e 100644 --- a/oak-lucene/src/main/java/org/apache/lucene/search/similarities/LMDirichletSimilarity.java +++ b/oak-lucene/src/main/java/org/apache/lucene/search/similarities/LMDirichletSimilarity.java @@ -40,7 +40,6 @@ import org.apache.lucene.search.Explanation; * contain the term, but with fewer occurrences than predicted by the collection * language model. The Lucene implementation returns {@code 0} for such * documents. - * </p> * * @lucene.experimental */ diff --git a/oak-lucene/src/main/java/org/apache/lucene/store/MMapDirectory.java b/oak-lucene/src/main/java/org/apache/lucene/store/MMapDirectory.java index fa87da8318..4d4c899ae3 100644 --- a/oak-lucene/src/main/java/org/apache/lucene/store/MMapDirectory.java +++ b/oak-lucene/src/main/java/org/apache/lucene/store/MMapDirectory.java @@ -82,7 +82,6 @@ import org.apache.lucene.util.Constants; * underlying channel immediately if at the same time the thread is * blocked on IO. The channel will remain closed and subsequent access * to {@link MMapDirectory} will throw a {@link ClosedChannelException}. - * </p> */ public class MMapDirectory extends FSDirectory { private boolean useUnmapHack = UNMAP_SUPPORTED; diff --git a/oak-lucene/src/main/java/org/apache/lucene/store/NIOFSDirectory.java b/oak-lucene/src/main/java/org/apache/lucene/store/NIOFSDirectory.java index 6a38ce3234..9c34cd1883 100644 --- a/oak-lucene/src/main/java/org/apache/lucene/store/NIOFSDirectory.java +++ b/oak-lucene/src/main/java/org/apache/lucene/store/NIOFSDirectory.java @@ -47,7 +47,6 @@ import java.util.concurrent.Future; // javadoc * implementation the position is apparently synchronized. See <a * href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=6265734";>here</a> * for details. - * </p> * <p> * <font color="red"><b>NOTE:</b> Accessing this class either directly or * indirectly from a thread while it's interrupted can close the @@ -57,7 +56,6 @@ import java.util.concurrent.Future; // javadoc * your application uses either {@link Thread#interrupt()} or * {@link Future#cancel(boolean)} you should use {@link SimpleFSDirectory} in * favor of {@link NIOFSDirectory}.</font> - * </p> */ public class NIOFSDirectory extends FSDirectory { diff --git a/oak-lucene/src/main/java/org/apache/lucene/util/BytesRefHash.java b/oak-lucene/src/main/java/org/apache/lucene/util/BytesRefHash.java index ea97cf095f..db0e9bed88 100644 --- a/oak-lucene/src/main/java/org/apache/lucene/util/BytesRefHash.java +++ b/oak-lucene/src/main/java/org/apache/lucene/util/BytesRefHash.java @@ -47,7 +47,6 @@ import org.apache.lucene.util.ByteBlockPool.DirectAllocator; * Note: The maximum capacity {@link BytesRef} instance passed to * {@link #add(BytesRef)} must not be longer than {@link ByteBlockPool#BYTE_BLOCK_SIZE}-2. * The internal storage is limited to 2GB total byte storage. - * </p> * * @lucene.internal */ diff --git a/oak-lucene/src/main/java/org/apache/lucene/util/FieldCacheSanityChecker.java b/oak-lucene/src/main/java/org/apache/lucene/util/FieldCacheSanityChecker.java index bce5a7674b..d0a1c84d18 100644 --- a/oak-lucene/src/main/java/org/apache/lucene/util/FieldCacheSanityChecker.java +++ b/oak-lucene/src/main/java/org/apache/lucene/util/FieldCacheSanityChecker.java @@ -41,7 +41,6 @@ import org.apache.lucene.store.AlreadyClosedException; /** * Provides methods for sanity checking that entries in the FieldCache * are not wasteful or inconsistent. - * </p> * <p> * Lucene 2.9 Introduced numerous enhancements into how the FieldCache * is used by the low levels of Lucene searching (for Sorting and @@ -54,7 +53,6 @@ import org.apache.lucene.store.AlreadyClosedException; * Later. This class provides an API for these applications (or their * Unit tests) to check at run time if the FieldCache contains "insane" * usages of the FieldCache. - * </p> * @lucene.experimental * @see FieldCache * @see FieldCacheSanityChecker.Insanity diff --git a/oak-lucene/src/main/java/org/apache/lucene/util/RecyclingByteBlockAllocator.java b/oak-lucene/src/main/java/org/apache/lucene/util/RecyclingByteBlockAllocator.java index a808a8c5e3..cfc99381b4 100644 --- a/oak-lucene/src/main/java/org/apache/lucene/util/RecyclingByteBlockAllocator.java +++ b/oak-lucene/src/main/java/org/apache/lucene/util/RecyclingByteBlockAllocator.java @@ -33,7 +33,6 @@ import org.apache.lucene.util.ByteBlockPool.Allocator; * {@link #getByteBlock()}. * <p> * Note: This class is not thread-safe - * </p> * @lucene.internal */ public final class RecyclingByteBlockAllocator extends ByteBlockPool.Allocator { diff --git a/oak-lucene/src/main/java/org/apache/lucene/util/RecyclingIntBlockAllocator.java b/oak-lucene/src/main/java/org/apache/lucene/util/RecyclingIntBlockAllocator.java index 2a323f3b94..cfadb3372f 100644 --- a/oak-lucene/src/main/java/org/apache/lucene/util/RecyclingIntBlockAllocator.java +++ b/oak-lucene/src/main/java/org/apache/lucene/util/RecyclingIntBlockAllocator.java @@ -33,7 +33,6 @@ import org.apache.lucene.util.IntBlockPool.Allocator; * {@link #getIntBlock()}. * <p> * Note: This class is not thread-safe - * </p> * @lucene.internal */ public final class RecyclingIntBlockAllocator extends Allocator { diff --git a/oak-lucene/src/main/java/org/apache/lucene/util/automaton/Automaton.java b/oak-lucene/src/main/java/org/apache/lucene/util/automaton/Automaton.java index 2b6b3e9ab5..2aaa818056 100644 --- a/oak-lucene/src/main/java/org/apache/lucene/util/automaton/Automaton.java +++ b/oak-lucene/src/main/java/org/apache/lucene/util/automaton/Automaton.java @@ -79,7 +79,6 @@ import org.apache.lucene.util.RamUsageEstimator; * wish to use the same Automaton from multiple threads. In general it is instead * recommended to use a {@link RunAutomaton} for multithreaded matching: it is immutable, * thread safe, and much faster. - * </p> * @lucene.experimental */ public class Automaton implements Cloneable { diff --git a/oak-security-spi/src/main/java/org/apache/jackrabbit/oak/spi/security/user/action/GroupAction.java b/oak-security-spi/src/main/java/org/apache/jackrabbit/oak/spi/security/user/action/GroupAction.java index fdbcd0265a..aad1265cbc 100644 --- a/oak-security-spi/src/main/java/org/apache/jackrabbit/oak/spi/security/user/action/GroupAction.java +++ b/oak-security-spi/src/main/java/org/apache/jackrabbit/oak/spi/security/user/action/GroupAction.java @@ -39,11 +39,9 @@ import javax.jcr.RepositoryException; * <p> * Please consult the parent interface {@link AuthorizableAction} for details on persisting changes, * configuring actions and the API through which actions are invoked. - * </p> * * <p> * For convenience, an {@link AbstractGroupAction} is provided. - * </p> * @since OAK 1.6 */ public interface GroupAction extends AuthorizableAction { diff --git a/oak-security-spi/src/main/java/org/apache/jackrabbit/oak/spi/security/user/action/UserAction.java b/oak-security-spi/src/main/java/org/apache/jackrabbit/oak/spi/security/user/action/UserAction.java index 3ce757e748..c7f33106ad 100644 --- a/oak-security-spi/src/main/java/org/apache/jackrabbit/oak/spi/security/user/action/UserAction.java +++ b/oak-security-spi/src/main/java/org/apache/jackrabbit/oak/spi/security/user/action/UserAction.java @@ -36,7 +36,6 @@ import org.jetbrains.annotations.Nullable; * <p> * See {@link AuthorizableAction} for details on persisting changes, * configuring actions and the API through which actions are invoked. - * </p> * * @since OAK 1.10 */ diff --git a/oak-segment-tar/src/test/java/org/apache/jackrabbit/oak/segment/CacheWeightEstimator.java b/oak-segment-tar/src/test/java/org/apache/jackrabbit/oak/segment/CacheWeightEstimator.java index 46067cfa1d..e2707fb43c 100644 --- a/oak-segment-tar/src/test/java/org/apache/jackrabbit/oak/segment/CacheWeightEstimator.java +++ b/oak-segment-tar/src/test/java/org/apache/jackrabbit/oak/segment/CacheWeightEstimator.java @@ -46,12 +46,10 @@ import org.junit.Test; * The test is <b>disabled</b> by default, to run it you need to set the * {@code CacheWeightsTest} system property:<br> * {@code mvn clean test -Dtest=CacheWeightEstimator -Dtest.opts.memory=-Xmx2G} - * </p> * <p> * To collect the results check the * {@code org.apache.jackrabbit.oak.segment.CacheWeightsTest-output.txt} file:<br> * {@code cat target/surefire-reports/org.apache.jackrabbit.oak.segment.CacheWeightEstimator-output.txt} - * </p> */ public class CacheWeightEstimator { diff --git a/oak-segment-tar/src/test/java/org/apache/jackrabbit/oak/segment/SegmentCompactionIT.java b/oak-segment-tar/src/test/java/org/apache/jackrabbit/oak/segment/SegmentCompactionIT.java index db3885ebe3..7428212221 100644 --- a/oak-segment-tar/src/test/java/org/apache/jackrabbit/oak/segment/SegmentCompactionIT.java +++ b/oak-segment-tar/src/test/java/org/apache/jackrabbit/oak/segment/SegmentCompactionIT.java @@ -122,7 +122,6 @@ import org.slf4j.LoggerFactory; * *<p>The test is <b>disabled</b> by default, to run it you need to set the {@code SegmentCompactionIT} system property:<br> * {@code mvn test -Dtest=SegmentCompactionIT -Dtest.opts.memory=-Xmx4G} - * </p> * * <p>TODO Leverage longevity test support from OAK-2771 once we have it.</p> */ diff --git a/oak-segment-tar/src/test/java/org/apache/jackrabbit/oak/segment/SegmentOverflowExceptionIT.java b/oak-segment-tar/src/test/java/org/apache/jackrabbit/oak/segment/SegmentOverflowExceptionIT.java index 5ab5e575b5..0206ab042e 100644 --- a/oak-segment-tar/src/test/java/org/apache/jackrabbit/oak/segment/SegmentOverflowExceptionIT.java +++ b/oak-segment-tar/src/test/java/org/apache/jackrabbit/oak/segment/SegmentOverflowExceptionIT.java @@ -54,11 +54,9 @@ import org.slf4j.LoggerFactory; * command line specify {@code -Dtest=SegmentOverflowExceptionIT} to enable it. Use {@code -Dtimeout=t} * to specify a different timeout {@code t} in milliseconds. Use {@code -Dmax-repo-size=s} to specify * a maximal repository size {@code s} in megabytes above which to stop the test. - * </p> * *<p>If you only want to run this test:<br> * {@code mvn verify -DfailIfNoTests=false -DskipTests -PintegrationTesting -Dtest=SegmentOverflowExceptionIT} - * </p> */ public class SegmentOverflowExceptionIT { private static final Logger LOG = LoggerFactory diff --git a/oak-segment-tar/src/test/java/org/apache/jackrabbit/oak/segment/file/LargeNumberOfPropertiesTestIT.java b/oak-segment-tar/src/test/java/org/apache/jackrabbit/oak/segment/file/LargeNumberOfPropertiesTestIT.java index e2d1d0eef5..4c125bb640 100644 --- a/oak-segment-tar/src/test/java/org/apache/jackrabbit/oak/segment/file/LargeNumberOfPropertiesTestIT.java +++ b/oak-segment-tar/src/test/java/org/apache/jackrabbit/oak/segment/file/LargeNumberOfPropertiesTestIT.java @@ -46,7 +46,6 @@ import org.slf4j.LoggerFactory; * *<p>If you only want to run this test:<br> * {@code mvn verify -Dsurefire.skip.ut=true -PintegrationTesting -Dit.test=LargeNumberOfPropertiesTestIT -DLargeNumberOfPropertiesTestIT=true} - * </p> */ public class LargeNumberOfPropertiesTestIT { diff --git a/oak-segment-tar/src/test/java/org/apache/jackrabbit/oak/segment/file/SegmentReferenceLimitTestIT.java b/oak-segment-tar/src/test/java/org/apache/jackrabbit/oak/segment/file/SegmentReferenceLimitTestIT.java index 53c3b5ee2e..c390c38988 100644 --- a/oak-segment-tar/src/test/java/org/apache/jackrabbit/oak/segment/file/SegmentReferenceLimitTestIT.java +++ b/oak-segment-tar/src/test/java/org/apache/jackrabbit/oak/segment/file/SegmentReferenceLimitTestIT.java @@ -51,7 +51,6 @@ import org.slf4j.LoggerFactory; * *<p>If you only want to run this test:<br> * {@code mvn verify -Dsurefire.skip.ut=true -PintegrationTesting -Dit.test=SegmentReferenceLimitTestIT -DSegmentReferenceLimitTestIT=true} - * </p> */ public class SegmentReferenceLimitTestIT {
