[jackrabbit-filevault] branch master updated: trivial: apply some javadoc fixes

[kw...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

kwin pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/jackrabbit-filevault.git


The following commit(s) were added to refs/heads/master by this push:
     new 3c823005 trivial: apply some javadoc fixes
3c823005 is described below

commit 3c82300553e2ef0c85bf699bdf8848b295aeb4a5
Author: Konrad Windszus <kw...@apache.org>
AuthorDate: Tue Sep 13 10:16:04 2022 +0200

    trivial: apply some javadoc fixes
---
 .../org/apache/jackrabbit/vault/packaging/PackageProperties.java    | 4 ++--
 .../java/org/apache/jackrabbit/vault/util/ItemNameComparator.java   | 4 ++--
 .../java/org/apache/jackrabbit/vault/util/ItemNameComparator2.java  | 2 +-
 .../main/java/org/apache/jackrabbit/vault/util/QNameComparator.java | 6 +++---
 .../main/java/org/apache/jackrabbit/vault/vlt/meta/VltEntry.java    | 2 +-
 5 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/vault-core/src/main/java/org/apache/jackrabbit/vault/packaging/PackageProperties.java b/vault-core/src/main/java/org/apache/jackrabbit/vault/packaging/PackageProperties.java
index 9c9c6d93..065efc6d 100644
--- a/vault-core/src/main/java/org/apache/jackrabbit/vault/packaging/PackageProperties.java
+++ b/vault-core/src/main/java/org/apache/jackrabbit/vault/packaging/PackageProperties.java
@@ -159,8 +159,8 @@ public interface PackageProperties {
     String NAME_PACKAGE_TYPE = "packageType";
 
     /**
-     * the prefix for an install hook property. eg:
-     * 'installhook.test1.class = ....'
+     * The prefix for an install hook property name. The full name may look like this:
+     * {@code installhook.test1.class}.
      */
     String PREFIX_INSTALL_HOOK = "installhook.";
 
diff --git a/vault-core/src/main/java/org/apache/jackrabbit/vault/util/ItemNameComparator.java b/vault-core/src/main/java/org/apache/jackrabbit/vault/util/ItemNameComparator.java
index 80c97eca..40677502 100644
--- a/vault-core/src/main/java/org/apache/jackrabbit/vault/util/ItemNameComparator.java
+++ b/vault-core/src/main/java/org/apache/jackrabbit/vault/util/ItemNameComparator.java
@@ -23,8 +23,8 @@ import java.util.Comparator;
 import javax.jcr.Item;
 
 
-/** {@code ItemNameComparator}...
- * Use {@link ItemNameComparator2} instead
+/**
+ * @deprecated Use {@link ItemNameComparator2} instead
  */
 @Deprecated
 
diff --git a/vault-core/src/main/java/org/apache/jackrabbit/vault/util/ItemNameComparator2.java b/vault-core/src/main/java/org/apache/jackrabbit/vault/util/ItemNameComparator2.java
index fe6677e1..fdfc1304 100644
--- a/vault-core/src/main/java/org/apache/jackrabbit/vault/util/ItemNameComparator2.java
+++ b/vault-core/src/main/java/org/apache/jackrabbit/vault/util/ItemNameComparator2.java
@@ -29,7 +29,7 @@ import org.apache.jackrabbit.spi.commons.name.NameFactoryImpl;
 import org.apache.jackrabbit.spi.commons.namespace.NamespaceResolver;
 
 /**
- * {@code ItemNameComparator2}...
+ * Orders items by their qualified name by using {@link QNameComparator}.
  */
 public class ItemNameComparator2 implements Comparator<Item> {
 
diff --git a/vault-core/src/main/java/org/apache/jackrabbit/vault/util/QNameComparator.java b/vault-core/src/main/java/org/apache/jackrabbit/vault/util/QNameComparator.java
index 76d1edf2..72d447f2 100644
--- a/vault-core/src/main/java/org/apache/jackrabbit/vault/util/QNameComparator.java
+++ b/vault-core/src/main/java/org/apache/jackrabbit/vault/util/QNameComparator.java
@@ -27,10 +27,10 @@ import javax.xml.namespace.QName;
  * Compares based on prefixes and local names as follows:
  * <ol>
  * <li>first ns prefixes</li>
- * <li>then prefixed attributes</li>
- * <li>only afterwards non-prefixed attributes</li>
+ * <li>then prefixed names</li>
+ * <li>only afterwards non-prefixed names</li>
  * </ol>
- * The letter case does not matter for the order, except when two names are equal. Only then the case will be considered as well.
+ * The latter case does not matter for the order, except when two names are equal. Only then the case will be considered as well.
  * 
  */
 public class QNameComparator implements Comparator<QName> {
diff --git a/vault-vlt/src/main/java/org/apache/jackrabbit/vault/vlt/meta/VltEntry.java b/vault-vlt/src/main/java/org/apache/jackrabbit/vault/vlt/meta/VltEntry.java
index ddfacc1b..83363dd1 100644
--- a/vault-vlt/src/main/java/org/apache/jackrabbit/vault/vlt/meta/VltEntry.java
+++ b/vault-vlt/src/main/java/org/apache/jackrabbit/vault/vlt/meta/VltEntry.java
@@ -20,7 +20,7 @@ import java.io.File;
 import java.io.IOException;
 
 /**
- * Represents an entry in of the {@link VltEntries}
+ * Represents an entry in {@link VltEntries}
  */
 public interface VltEntry {