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 28e5467ed14e3e2b6650ecf018d8678cc1414a21 Author: Julian Reschke <[email protected]> AuthorDate: Thu Apr 10 09:15:57 2025 +0100 OAK-11650: Fix Javadoc errors - one-line only </li> --- .../oak/scalability/suites/ScalabilityBlobSearchSuite.java | 4 ---- .../oak/scalability/suites/ScalabilityNodeRelationshipSuite.java | 1 - .../jackrabbit/oak/scalability/suites/ScalabilityNodeSuite.java | 9 --------- .../oak/scalability/benchmarks/search/ConcurrentReader.java | 3 --- .../oak/scalability/suites/ScalabilityAbstractSuite.java | 3 --- .../org/apache/jackrabbit/oak/security/user/UserImporter.java | 3 --- .../org/apache/jackrabbit/oak/security/user/UserProvider.java | 1 - .../apache/jackrabbit/api/observation/JackrabbitEventFilter.java | 7 ------- .../lucene/codecs/lucene40/Lucene40StoredFieldsFormat.java | 3 --- .../apache/lucene/codecs/lucene40/Lucene40TermVectorsFormat.java | 3 --- .../lucene/codecs/lucene41/Lucene41StoredFieldsFormat.java | 2 -- .../apache/lucene/codecs/lucene42/Lucene42TermVectorsFormat.java | 2 -- .../oak/spi/security/authentication/AbstractLoginModule.java | 1 - .../org/apache/jackrabbit/oak/plugins/document/ClusterView.java | 1 - .../oak/plugins/document/DocumentDiscoveryLiteService.java | 1 - 15 files changed, 44 deletions(-) diff --git a/oak-benchmarks-lucene/src/main/java/org/apache/jackrabbit/oak/scalability/suites/ScalabilityBlobSearchSuite.java b/oak-benchmarks-lucene/src/main/java/org/apache/jackrabbit/oak/scalability/suites/ScalabilityBlobSearchSuite.java index 24e386040a..bf4f5d8414 100644 --- a/oak-benchmarks-lucene/src/main/java/org/apache/jackrabbit/oak/scalability/suites/ScalabilityBlobSearchSuite.java +++ b/oak-benchmarks-lucene/src/main/java/org/apache/jackrabbit/oak/scalability/suites/ScalabilityBlobSearchSuite.java @@ -60,17 +60,13 @@ import org.apache.jackrabbit.oak.scalability.util.NodeTypeUtils; * <li> * <code>fileWriters</code> - Controls the number of concurrent background threads for writing blobs. * Defaults to 0. - * </li> * <li> * <code>fileReaders</code> - Controls the number of concurrent background threads for reading blobs. * Defaults to 1. - * </li> * <li> * <code>fileSize</code> - Controls the size in KB of the blobs. Defaults to 1. - * </li> * <li> * <code>maxAssets</code> - Controls the max child nodes created under a node. Defaults to 500. - * </li> * </ul> */ public class ScalabilityBlobSearchSuite extends ScalabilityNodeSuite { diff --git a/oak-benchmarks-lucene/src/main/java/org/apache/jackrabbit/oak/scalability/suites/ScalabilityNodeRelationshipSuite.java b/oak-benchmarks-lucene/src/main/java/org/apache/jackrabbit/oak/scalability/suites/ScalabilityNodeRelationshipSuite.java index 196d847b98..9bab05e08d 100644 --- a/oak-benchmarks-lucene/src/main/java/org/apache/jackrabbit/oak/scalability/suites/ScalabilityNodeRelationshipSuite.java +++ b/oak-benchmarks-lucene/src/main/java/org/apache/jackrabbit/oak/scalability/suites/ScalabilityNodeRelationshipSuite.java @@ -70,7 +70,6 @@ import org.apache.jackrabbit.guava.common.base.Splitter; * </ul> * * Defaults to 10,5,2,1. - * </li> * </ul> * */ diff --git a/oak-benchmarks-lucene/src/main/java/org/apache/jackrabbit/oak/scalability/suites/ScalabilityNodeSuite.java b/oak-benchmarks-lucene/src/main/java/org/apache/jackrabbit/oak/scalability/suites/ScalabilityNodeSuite.java index dadcbf91d6..946413c626 100644 --- a/oak-benchmarks-lucene/src/main/java/org/apache/jackrabbit/oak/scalability/suites/ScalabilityNodeSuite.java +++ b/oak-benchmarks-lucene/src/main/java/org/apache/jackrabbit/oak/scalability/suites/ScalabilityNodeSuite.java @@ -77,33 +77,24 @@ import org.slf4j.LoggerFactory; * <li> * <code>loaders</code> - Controls the number of concurrent threads for loading blobs initially. * Defaults to 1. - * </li> * <li> * <code>testers</code> - Controls the number of concurrent tester threads. Defaults to 1. - * </li> * <li> * <code>nodeLevels</code> - Comma separated string property that governs the depth and the number of * nodes in the hierarchy. Defaults to 10, 5, 2. - * </li> * <li> * <code>densityLevel</code> - Controls the percentage of root nodes which will have sub nodes created. * Defaults to 100. - * </li> * <li> * <code>index</code> - Controls if the index definitions are to be created. Defaults to false. - * </li> * <li> * <code>asyncIndex</code> - Controls whether the indexing is async. Defaults to false. - * </li> * <li> * <code>noFullIndex</code> - Controls whether fulltext indexing is enabled or disabled. Defaults to false. - * </li> * <li> * <code>randDate</code> - Controls whether to generate random dates in a range. Defaults to false. - * </li> * <li> * <code>customType</code> - Controls if nodes created in the load have a custom node type. Defaults to false. - * </li> * </ul> * */ diff --git a/oak-benchmarks/src/main/java/org/apache/jackrabbit/oak/scalability/benchmarks/search/ConcurrentReader.java b/oak-benchmarks/src/main/java/org/apache/jackrabbit/oak/scalability/benchmarks/search/ConcurrentReader.java index 564aa30fc1..f1d4bdbcd6 100644 --- a/oak-benchmarks/src/main/java/org/apache/jackrabbit/oak/scalability/benchmarks/search/ConcurrentReader.java +++ b/oak-benchmarks/src/main/java/org/apache/jackrabbit/oak/scalability/benchmarks/search/ConcurrentReader.java @@ -46,15 +46,12 @@ import java.util.UUID; * <li> * <code>concurrentWriters</code> - Controls the number of concurrent background threads for writing nodes. * Defaults to 0. - * </li> * <li> * <code>concurrentReaders</code> - Controls the number of concurrent background threads for reading nodes. * Defaults to 0. - * </li> * <li> * <code>assets</code> - Controls the number of nodes to read/write in the background threads. * Defaults to 100. - * </li> * </ul> * */ diff --git a/oak-benchmarks/src/main/java/org/apache/jackrabbit/oak/scalability/suites/ScalabilityAbstractSuite.java b/oak-benchmarks/src/main/java/org/apache/jackrabbit/oak/scalability/suites/ScalabilityAbstractSuite.java index cb714edff9..e4c45e33cb 100644 --- a/oak-benchmarks/src/main/java/org/apache/jackrabbit/oak/scalability/suites/ScalabilityAbstractSuite.java +++ b/oak-benchmarks/src/main/java/org/apache/jackrabbit/oak/scalability/suites/ScalabilityAbstractSuite.java @@ -74,14 +74,11 @@ import org.slf4j.LoggerFactory; * <ul> * <li> * <code>profile</code> - Controls whether to profile the benchmark or not. Defaults to false. - * </li> * <li> * <code>noWarmup</code> - Controls whether to run warmup or not before each benchmark. Defaults to false. - * </li> * <li> * <code>increments</code> - Comma separated list which controls the incremental load for each iteration. * Defaults to 1,2,5. - * </li> * </ul> */ public abstract class ScalabilityAbstractSuite implements ScalabilitySuite, CSVResultGenerator { diff --git a/oak-core/src/main/java/org/apache/jackrabbit/oak/security/user/UserImporter.java b/oak-core/src/main/java/org/apache/jackrabbit/oak/security/user/UserImporter.java index 19f6b85061..1b70f82491 100644 --- a/oak-core/src/main/java/org/apache/jackrabbit/oak/security/user/UserImporter.java +++ b/oak-core/src/main/java/org/apache/jackrabbit/oak/security/user/UserImporter.java @@ -97,10 +97,8 @@ import static org.apache.jackrabbit.oak.api.Type.STRINGS; * <ul> * <li>The importer will only be initialized if the user manager exposed by * the session is an instance of {@code UserManagerImpl}. - * </li> * <li>The importer will only be initialized if the editing session starting * this import is the same as the UserManager's Session instance. - * </li> * <li>The jcr:uuid property of user and groups is defined to represent the * hashed authorizable id as calculated by the UserManager. This importer * is therefore not able to handle imports with @@ -132,7 +130,6 @@ import static org.apache.jackrabbit.oak.api.Type.STRINGS; * <li>{@link ImportBehavior#NAME_ABORT abort}: The import is immediately * aborted with a ConstraintViolationException. (<strong>default</strong>)</li> * </ul> - * </li> * </ul> */ class UserImporter implements ProtectedPropertyImporter, ProtectedNodeImporter, UserConstants { diff --git a/oak-core/src/main/java/org/apache/jackrabbit/oak/security/user/UserProvider.java b/oak-core/src/main/java/org/apache/jackrabbit/oak/security/user/UserProvider.java index 94114ac7c0..f6fbbc9fdd 100644 --- a/oak-core/src/main/java/org/apache/jackrabbit/oak/security/user/UserProvider.java +++ b/oak-core/src/main/java/org/apache/jackrabbit/oak/security/user/UserProvider.java @@ -79,7 +79,6 @@ import static org.apache.jackrabbit.oak.spi.nodetype.NodeTypeConstants.NODE_TYPE * + aS [rep:AuthorizableFolder] * -> + aSmith [rep:User] * </pre> - * </li> * <li>The node name is calculated from the specified authorizable ID according * to the logic provided by the configured {@link AuthorizableNodeName} * implementation. If no name generator is present in the configuration diff --git a/oak-jackrabbit-api/src/main/java/org/apache/jackrabbit/api/observation/JackrabbitEventFilter.java b/oak-jackrabbit-api/src/main/java/org/apache/jackrabbit/api/observation/JackrabbitEventFilter.java index f54de02aae..39cfa5c2a4 100644 --- a/oak-jackrabbit-api/src/main/java/org/apache/jackrabbit/api/observation/JackrabbitEventFilter.java +++ b/oak-jackrabbit-api/src/main/java/org/apache/jackrabbit/api/observation/JackrabbitEventFilter.java @@ -39,7 +39,6 @@ import org.osgi.annotation.versioning.ConsumerType; * <code>eventTypes</code>: * A bitwise <code>OR</code> of the event types to be listened to. See * {@link javax.jcr.observation.Event} for details. - * </li> * <li> * <code>absPath</code>, <code>absPaths</code>, <code>excludedPaths</code>, * <code>isDeep</code>: Only events whose associated parent node is at one @@ -49,7 +48,6 @@ import org.osgi.annotation.versioning.ConsumerType; * <code>excludedPaths</code> or its subgraph. * It is permissible to register a listener for a path where no node currently * exists. - * </li> * <li> * <code>uuid</code>: * Only events whose associated parent node has one of @@ -58,7 +56,6 @@ import org.osgi.annotation.versioning.ConsumerType; * events received. Note that specifying an empty array instead of * <code>null</code> would result in no nodes being listened to. The term * "UUID" is used for compatibility with JCR 1.0. - * </li> * <li> * <code>nodeTypeName</code>: * Only events whose associated parent node has @@ -67,20 +64,16 @@ import org.osgi.annotation.versioning.ConsumerType; * type-related restriction is placed on events received. Note that * specifying an empty array instead of <code>null</code> would result in no * nodes types being listened to. - * </li> * <li> * <code>noLocal</code>: if <code>true</code>, then events * generated by the session through which the listener was registered are * ignored. Otherwise, they are not ignored. - * </li> * <li> * <code>noExternal</code>: if <code>true</code>, then events * from external cluster nodes are ignored. Otherwise, they are not ignored. - * </li> * <li> * <code>noInternal</code>: if <code>true</code>, then events * from this cluster node are ignored. Otherwise, they are not ignored. - * </li> * </ul> * The restrictions are "ANDed" together. In other words, for a particular node to be "listened to" it * must meet all the restrictions. diff --git a/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene40/Lucene40StoredFieldsFormat.java b/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene40/Lucene40StoredFieldsFormat.java index cd4e8f511f..a6f16c2896 100644 --- a/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene40/Lucene40StoredFieldsFormat.java +++ b/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene40/Lucene40StoredFieldsFormat.java @@ -54,7 +54,6 @@ import org.apache.lucene.store.IOContext; * <li>Header --> {@link CodecUtil#writeHeader CodecHeader}</li> * <li>FieldValuesPosition --> {@link DataOutput#writeLong Uint64}</li> * </ul> - * </li> * <li> * <p><a name="field_data" id="field_data"></a>The field data, or <tt>.fdt</tt> file.</p> * <p>This contains the stored fields of each document, as follows:</p> @@ -78,12 +77,10 @@ import org.apache.lucene.store.IOContext; * <li>3<<3: Value is Int as Float (as of {@link Float#intBitsToFloat(int)}</li> * <li>4<<3: Value is Long as Double (as of {@link Double#longBitsToDouble(long)}</li> * </ul> - * </li> * </ul> * <li>Value --> String | BinaryValue | Int | Long (depending on Bits)</li> * <li>BinaryValue --> ValueSize, <{@link DataOutput#writeByte Byte}>^ValueSize</li> * <li>ValueSize --> {@link DataOutput#writeVInt VInt}</li> - * </li> * </ul> * </ol> * @lucene.experimental */ diff --git a/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene40/Lucene40TermVectorsFormat.java b/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene40/Lucene40TermVectorsFormat.java index 4546ec3712..6a9c83109b 100644 --- a/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene40/Lucene40TermVectorsFormat.java +++ b/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene40/Lucene40TermVectorsFormat.java @@ -53,7 +53,6 @@ import org.apache.lucene.store.IOContext; * <li>DocumentPosition --> {@link DataOutput#writeLong UInt64} (offset in the .tvd file)</li> * <li>FieldPosition --> {@link DataOutput#writeLong UInt64} (offset in the .tvf file)</li> * </ul> - * </li> * <li><a name="tvd" id="tvd"></a> * <p>The Document or .tvd file.</p> * <p>This contains, for each document, the number of fields, a list of the fields @@ -71,7 +70,6 @@ import org.apache.lucene.store.IOContext; * <li>FieldPositions --> <FieldPositionDelta> <sup>NumFields-1</sup></li> * <li>FieldPositionDelta --> {@link DataOutput#writeVLong VLong}</li> * </ul> - * </li> * <li><a name="tvf" id="tvf"></a> * <p>The Field or .tvf file.</p> * <p>This file contains, for each field that has a term vector stored, a list of @@ -118,7 +116,6 @@ import org.apache.lucene.store.IOContext; * <li>Offsets are stored as delta encoded VInts. The first VInt is the * startOffset, the second is the endOffset.</li> * </ul> - * </li> * </ol> */ public class Lucene40TermVectorsFormat extends TermVectorsFormat { diff --git a/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene41/Lucene41StoredFieldsFormat.java b/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene41/Lucene41StoredFieldsFormat.java index e78d827f76..63b488fd77 100644 --- a/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene41/Lucene41StoredFieldsFormat.java +++ b/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene41/Lucene41StoredFieldsFormat.java @@ -108,7 +108,6 @@ import org.apache.lucene.util.packed.PackedInts; * <li>In case documents are incompressible, CompressedDocs will be less than * 0.5% larger than Docs.</li> * </ul> - * </li> * <li><a name="field_index" id="field_index"></a> * <p>A fields index file (extension <tt>.fdx</tt>).</p> * <ul> @@ -116,7 +115,6 @@ import org.apache.lucene.util.packed.PackedInts; * <li>Header --> {@link CodecUtil#writeHeader CodecHeader}</li> * <li>ChunkIndex: See {@link CompressingStoredFieldsIndexWriter}</li> * </ul> - * </li> * </ol> * <p><b>Known limitations</b></p> * <p>This {@link StoredFieldsFormat} does not support individual documents diff --git a/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene42/Lucene42TermVectorsFormat.java b/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene42/Lucene42TermVectorsFormat.java index 71babba894..64a37a6270 100644 --- a/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene42/Lucene42TermVectorsFormat.java +++ b/oak-lucene/src/main/java/org/apache/lucene/codecs/lucene42/Lucene42TermVectorsFormat.java @@ -116,7 +116,6 @@ import org.apache.lucene.util.packed.PackedInts; * <li>Terms: term bytes</li> * <li>Payloads: payload bytes (if the field has payloads)</li> * </ul> - * </li> * <li><a name="vector_index" id="vector_index"></a> * <p>An index file (extension <tt>.tvx</tt>).</p> * <ul> @@ -124,7 +123,6 @@ import org.apache.lucene.util.packed.PackedInts; * <li>Header --> {@link CodecUtil#writeHeader CodecHeader}</li> * <li>ChunkIndex: See {@link CompressingStoredFieldsIndexWriter}</li> * </ul> - * </li> * </ol> * @lucene.experimental */ diff --git a/oak-security-spi/src/main/java/org/apache/jackrabbit/oak/spi/security/authentication/AbstractLoginModule.java b/oak-security-spi/src/main/java/org/apache/jackrabbit/oak/spi/security/authentication/AbstractLoginModule.java index c54b28d64b..aed5c7fa49 100644 --- a/oak-security-spi/src/main/java/org/apache/jackrabbit/oak/spi/security/authentication/AbstractLoginModule.java +++ b/oak-security-spi/src/main/java/org/apache/jackrabbit/oak/spi/security/authentication/AbstractLoginModule.java @@ -85,7 +85,6 @@ import static java.util.concurrent.TimeUnit.NANOSECONDS; * <li>options: The configuration options of this login module as specified * in the {@link javax.security.auth.login.Configuration}.</li> * </ul> - * </li> * <li>{@link LoginModule#logout() Logout}: * If the authenticated subject is not empty this logout implementation * attempts to clear both principals and public credentials and returns diff --git a/oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/ClusterView.java b/oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/ClusterView.java index 5ea00bc6e8..3ff2cda042 100644 --- a/oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/ClusterView.java +++ b/oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/ClusterView.java @@ -82,7 +82,6 @@ import org.apache.jackrabbit.oak.commons.json.JsopBuilder; * ids that are all in the process of deactivating and for which therefore some * data might still be making its way to the local instance. So any changes that * were done by instances that are deactivating might not yet be visible locally - * </li> * <li>deactive = deactive instance ids: this is the list of instance ids that * are not running nor do they have any data pending to become visible by the * local instance</li> diff --git a/oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/DocumentDiscoveryLiteService.java b/oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/DocumentDiscoveryLiteService.java index 694335ed7d..52ec3c480d 100644 --- a/oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/DocumentDiscoveryLiteService.java +++ b/oak-store-document/src/main/java/org/apache/jackrabbit/oak/plugins/document/DocumentDiscoveryLiteService.java @@ -59,7 +59,6 @@ import org.slf4j.LoggerFactory; * the following states: * <ul> * <li>active: the instance is currently running and has an up-to-date lease - * </li> * <li>deactivating: the instance failed to update the lease recently thus a * recovery is happening - or it has just finished and the local instance is yet * to do a backgroundRead before it has finished reading the crashed/shutdown
