Fix Javadocs
authorMathieu Baudier <mbaudier@argeo.org>
Sat, 15 Oct 2022 08:22:55 +0000 (10:22 +0200)
committerMathieu Baudier <mbaudier@argeo.org>
Sat, 15 Oct 2022 08:22:55 +0000 (10:22 +0200)
21 files changed:
jcr/org.argeo.cms.jcr.ui/src/org/argeo/cms/ui/forms/FormUtils.java
jcr/org.argeo.cms.jcr.ui/src/org/argeo/cms/ui/jcr/model/RepositoriesElem.java
jcr/org.argeo.cms.jcr.ui/src/org/argeo/eclipse/ui/jcr/lists/NodeViewerComparator.java
jcr/org.argeo.cms.jcr.ui/src/org/argeo/eclipse/ui/jcr/lists/RowViewerComparator.java
jcr/org.argeo.cms.jcr/src/org/argeo/jcr/Jcr.java
org.argeo.api.acr/src/org/argeo/api/acr/AttributeFormatter.java
org.argeo.api.acr/src/org/argeo/api/acr/ContentName.java
org.argeo.api.acr/src/org/argeo/api/acr/CrAttributeType.java
org.argeo.api.acr/src/org/argeo/api/acr/DName.java
org.argeo.api.uuid/src/org/argeo/api/uuid/AbstractAsyncUuidFactory.java
org.argeo.api.uuid/src/org/argeo/api/uuid/AbstractUuidFactory.java
org.argeo.api.uuid/src/org/argeo/api/uuid/BasicNameUuid.java
org.argeo.api.uuid/src/org/argeo/api/uuid/ConcurrentTimeUuidState.java
org.argeo.api.uuid/src/org/argeo/api/uuid/ConcurrentUuidFactory.java
org.argeo.api.uuid/src/org/argeo/api/uuid/GUID.java
org.argeo.api.uuid/src/org/argeo/api/uuid/MacAddressUuidFactory.java
org.argeo.api.uuid/src/org/argeo/api/uuid/UuidFactory.java
org.argeo.cms/src/org/argeo/cms/internal/osgi/GogoShellKiller.java
org.argeo.util/src/org/argeo/util/http/HttpStatus.java
org.argeo.util/src/org/argeo/util/naming/Distinguished.java
swt/org.argeo.cms.swt/src/org/argeo/cms/swt/MouseDoubleClick.java

index ef49c8ae5652e5c351b8b5113c304673f4470711..eeafabbe1454a9ca2bd3a1584d4a4dfedc57ad1e 100644 (file)
@@ -121,7 +121,7 @@ public class FormUtils {
         * @param value
         * @param label
         *            a potentially distinct label
-        * @return
+        * @return the link
         */
        public static String getPhoneLink(String value, String label) {
                StringBuilder builder = new StringBuilder();
@@ -146,7 +146,7 @@ public class FormUtils {
         * @param value
         * @param label
         *            a potentially distinct label
-        * @return
+        * @return the link
         */
        public static String getMailLink(String value, String label) {
                StringBuilder builder = new StringBuilder();
index 742800b0b54e364dde808a7fa093a08aa3ebad32..8c40f8b37c39ca004b921d615632e418aee66eb8 100644 (file)
@@ -21,7 +21,7 @@ import org.argeo.eclipse.ui.dialogs.ErrorFeedback;
  * UI Tree component that implements the Argeo abstraction of a
  * {@link RepositoryFactory} that enable a user to "mount" various repositories
  * in a single Tree like View. It is usually meant to be at the root of the UI
- * Tree and thus {@link getParent()} method will return null.
+ * Tree and thus {@link #getParent()} method will return null.
  * 
  * The {@link RepositoryFactory} is injected at instantiation time and must be
  * use get or register new {@link Repository} objects upon which a reference is
index 341b3abee17a284d57ca81f6c21d1d22cc986c5f..d9904605fc07630fb4048a4f61c1816df6bcc9a7 100644 (file)
@@ -43,7 +43,7 @@ public class NodeViewerComparator extends ViewerComparator {
         * @param viewer
         * @param e1
         * @param e2
-        * @return
+        * @return the comparison
         */
        @Override
        public int compare(Viewer viewer, Object e1, Object e2) {
index 455fb0dcd213deb5a320b7b0e639054a1e9685c0..60d637d61f5339097f80e481a272a8a93ce55909 100644 (file)
@@ -24,7 +24,7 @@ public class RowViewerComparator extends NodeViewerComparator {
         * @param viewer
         * @param e1
         * @param e2
-        * @return
+        * @return the comparison
         */
        @Override
        public int compare(Viewer viewer, Object e1, Object e2) {
index 1936f2398b8e26a56a217ff4e89e64d96b7fd908..49b008d70751e24e4f362c9e5e2b9caab66f06cc 100644 (file)
@@ -387,7 +387,6 @@ public class Jcr {
         * 
         * @param node   the node
         * @param mixins the mixins
-        * @return the created node
         * @see Node#addMixin(String)
         */
        public static void addMixin(Node node, String... mixins) {
index 41600331a21b756b634280c09ef70ab40aeb7af1..c7023f1a37a4a58b2582fc62e4f9f7d509fb7336 100644 (file)
@@ -4,9 +4,8 @@ package org.argeo.api.acr;
  * An attribute type MUST consistently parse a string to an object so that
  * <code>parse(obj.toString()).equals(obj)</code> is verified.
  * {@link #format(Object)} can be overridden to provide more efficient
- * implementations but the returned
- * <code>String<code> MUST be the same, that is <code>format(obj).equals(obj.toString())</code>
- * is verified.
+ * implementations but the returned <code>String</code> MUST be the same, that
+ * is <code>format(obj).equals(obj.toString())</code> is verified.
  */
 public interface AttributeFormatter<T> {
        /** Parses a String to a Java object. */
index fdeb60776a426b4bf28fb29bc1de9f079ab66170..113f98da0d6350d07279d261e2a99b443b25541a 100644 (file)
@@ -24,7 +24,7 @@ public class ContentName extends QName {
         * The UUID v3 of http://www.w3.org/2000/xmlns/ within the standard DNS
         * namespace, to be used as a base for the namespaces.
         * 
-        * @see https://www.w3.org/TR/xml-names/#ns-decl
+        * @see "https://www.w3.org/TR/xml-names/#ns-decl"
         */
        // uuidgen --md5 --namespace @dns --name http://www.w3.org/2000/xmlns/
        // NOTE : must be declared before default namespaces
index 4dae9221c4eae4036a0a6f15f18e31dcb08d5ed0..55ad079ec16b1927c8bc214c877a000d0f281ef7 100644 (file)
@@ -18,7 +18,7 @@ import javax.xml.namespace.QName;
 /**
  * Minimal standard attribute types that MUST be supported. All related classes
  * belong to java.base and can be implicitly derived form a given
- * <code>String<code>.
+ * <code>String</code>.
  */
 public enum CrAttributeType {
        BOOLEAN(Boolean.class, W3C_XML_SCHEMA_NS_URI, "boolean", new BooleanFormatter()), //
@@ -143,7 +143,7 @@ public enum CrAttributeType {
                Objects.requireNonNull(value, "Cannot cast a null value");
                if (String.class.isAssignableFrom(clss)) {
                        return Optional.of((T) value.toString());
-               } 
+               }
                // Numbers
                else if (Long.class.isAssignableFrom(clss)) {
                        if (value instanceof Long)
index 162ae919f88a161e0bdf8da4fd3c20454e463c95..be065a8d96750ef8d0e2399be80bf3b0753e49a6 100644 (file)
@@ -4,8 +4,8 @@ package org.argeo.api.acr;
  * Name for core concepts with the same semantics as defined in the WebDav
  * standard and extensions.
  * 
- * @see http://www.webdav.org/specs/rfc4918.html
- * @see http://www.webdav.org/specs/rfc3744.html
+ * @see "http://www.webdav.org/specs/rfc4918.html"
+ * @see "http://www.webdav.org/specs/rfc3744.html"
  */
 public enum DName implements QNamed
 
index 52becc85ac0946a018e692b1065e3b20c999c83a..fc1c931ff6b4945a09dadec175811bf9854ace73 100644 (file)
@@ -63,7 +63,7 @@ public abstract class AbstractAsyncUuidFactory extends AbstractUuidFactory imple
        }
 
        /**
-        * If positive, only clock_hi is taken from the argument (range & 0x3F00), if
+        * If positive, only clock_hi is taken from the argument (range amp; 0x3F00), if
         * negative, the full range of possible values is used.
         */
        public void setCurrentClockSequenceRange(long range) {
index 1bbc4391f248b599293ac4df74c97dccca675ab6..4f2cf3765dcb69d6d912a7491511bee1350742f5 100644 (file)
@@ -12,7 +12,7 @@ import java.util.UUID;
 /**
  * Implementation of the basic RFC4122 algorithms.
  * 
- * @see https://datatracker.ietf.org/doc/html/rfc4122
+ * @see "https://datatracker.ietf.org/doc/html/rfc4122"
  */
 public abstract class AbstractUuidFactory implements UuidFactory {
 
@@ -127,7 +127,7 @@ public abstract class AbstractUuidFactory implements UuidFactory {
        /**
         * Force this node id to be identified as no MAC address.
         * 
-        * @see https://datatracker.ietf.org/doc/html/rfc4122#section-4.5
+        * @see "https://datatracker.ietf.org/doc/html/rfc4122#section-4.5"
         */
        protected static void forceToNoMacAddress(byte[] nodeId, int offset) {
                assert nodeId != null && offset < nodeId.length;
index b883e0dcb62f6dda23d6f17ae858b5329369d990..c9f130df96a49a157905451ff1fe02a2b708d4c3 100644 (file)
@@ -13,7 +13,7 @@ public class BasicNameUuid extends TypedUuid {
        }
 
        /**
-        * Always returns <code>true</true> since it is unknown from which values it was
+        * Always returns <code>true</code> since it is unknown from which values it was
         * constructed..
         */
        @Override
index 8131df8eebbd0bfdb9dad16e9210b64b84a1ea88..6dbd403dd506468341c42b09f13e419619740413 100644 (file)
@@ -9,6 +9,7 @@ import java.util.Map;
 import java.util.Objects;
 import java.util.Set;
 import java.util.WeakHashMap;
+import java.util.concurrent.ForkJoinPool;
 import java.util.concurrent.atomic.AtomicLong;
 
 import org.argeo.api.uuid.UuidFactory.TimeUuidState;
@@ -21,7 +22,7 @@ import org.argeo.api.uuid.UuidFactory.TimeUuidState;
  * sequences. If that limit is reached, the clock sequence which has not be used
  * for the most time is reallocated to the new thread. It is assumed that the
  * context where time uUIDs will be generated will often be using thread pools
- * (e.g. {@link ForkJoinPool#commonPool(), http server, database access, etc.)
+ * (e.g. {@link ForkJoinPool#commonPool()}, http server, database access, etc.)
  * and that such reallocation won't have to happen too often.
  */
 public class ConcurrentTimeUuidState implements UuidFactory.TimeUuidState {
index f2bd43689772a24c87ba5ad81e53f1f0fe00ddb4..130a90a84bfb49be449539bd939fc2cc696bd742 100644 (file)
@@ -10,7 +10,7 @@ import java.util.UUID;
  * A configurable implementation of an {@link AsyncUuidFactory}, which can be
  * used as a base class for more optimised implementations.
  * 
- * @see https://datatracker.ietf.org/doc/html/rfc4122
+ * @see "https://datatracker.ietf.org/doc/html/rfc4122"
  */
 public class ConcurrentUuidFactory extends AbstractAsyncUuidFactory implements TypedUuidFactory {
 //     private final static Logger logger = System.getLogger(ConcurrentUuidFactory.class.getName());
index a9a5af17d098ddd9c8bb0cb46692c0b75d1d0e28..0775cbf75e7e9419911e63215b2686b512a7ce9c 100644 (file)
@@ -5,7 +5,7 @@ import java.util.UUID;
 /**
  * A variant 6 {@link UUID}.
  * 
- * @see https://datatracker.ietf.org/doc/html/rfc4122#section-4.1.1
+ * @see "https://datatracker.ietf.org/doc/html/rfc4122#section-4.1.1"
  */
 public class GUID extends TypedUuid {
        private static final long serialVersionUID = APM.SERIAL;
@@ -26,7 +26,7 @@ public class GUID extends TypedUuid {
         * <li>P: (1db31359-bdd8-5a0f-b672-30c247d582c5)</li>
         * </ul>
         * 
-        * @see https://docs.microsoft.com/en-us/dotnet/api/system.guid.tostring
+        * @see "https://docs.microsoft.com/en-us/dotnet/api/system.guid.tostring"
         */
        public static String toString(UUID uuid, char format, boolean upperCase) {
                String str;
index f9004ce3e6782e1f207b41a61be0ae6c2405fb37..31fe3783112661e23f28074d31669870c0db0d42 100644 (file)
@@ -11,7 +11,7 @@ import java.util.UUID;
  * An {@link UUID} factory whose node id (for time based UUIDs) is the hardware
  * MAC address as specified in RFC4122.
  * 
- * @see https://datatracker.ietf.org/doc/html/rfc4122.html#section-4.1.6
+ * @see "https://datatracker.ietf.org/doc/html/rfc4122.html#section-4.1.6"
  */
 public class MacAddressUuidFactory extends ConcurrentUuidFactory {
        public MacAddressUuidFactory() {
index 4ab6c2e4b754d7818be29a24fece361373b5f6e9..ee5aa699472659127a4d40f1c3dbedaf6100490d 100644 (file)
@@ -14,7 +14,7 @@ import java.util.function.Supplier;
  * {@link Supplier#get()} method MUST be a v4 UUID (random).
  * 
  * @see UUID
- * @see https://datatracker.ietf.org/doc/html/rfc4122
+ * @see "https://datatracker.ietf.org/doc/html/rfc4122"
  */
 public interface UuidFactory extends Supplier<UUID> {
 
@@ -184,7 +184,7 @@ public interface UuidFactory extends Supplier<UUID> {
         * Whether this UUID is time based but was not generated from an IEEE 802
         * address, as per Section 4.5 of RFC4122.
         * 
-        * @see https://datatracker.ietf.org/doc/html/rfc4122#section-4.5
+        * @see "https://datatracker.ietf.org/doc/html/rfc4122#section-4.5"
         */
        static boolean isTimeBasedWithMacAddress(UUID uuid) {
                if (uuid.version() == 1) {
@@ -202,7 +202,7 @@ public interface UuidFactory extends Supplier<UUID> {
         * The state of a time based UUID generator, as described and discussed in
         * section 4.2.1 of RFC4122.
         * 
-        * @see https://datatracker.ietf.org/doc/html/rfc4122#section-4.2.1
+        * @see "https://datatracker.ietf.org/doc/html/rfc4122#section-4.2.1"
         */
        interface TimeUuidState {
                /** Current node id and clock sequence for this thread. */
index a8c901644b13e21cb9d63f565efac5832c35d1ea..9de7a4fd13f081497909bc6c08041e321a433400 100644 (file)
@@ -3,7 +3,7 @@ package org.argeo.cms.internal.osgi;
 /**
  * Workaround for killing Gogo shell by system shutdown.
  * 
- * @see https://issues.apache.org/jira/browse/FELIX-4208
+ * @see "https://issues.apache.org/jira/browse/FELIX-4208"
  */
 class GogoShellKiller extends Thread {
 
index 8fb109bd42fe08c9ec1ee68870c53956dcbadf32..11e0a3645be2a8100d6499d66584909c65c5734c 100644 (file)
@@ -3,7 +3,7 @@ package org.argeo.util.http;
 /**
  * Standard HTTP response status codes (including WebDav ones).
  * 
- * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Status
+ * @see "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status"
  */
 public enum HttpStatus {
        // Successful responses (200–299)
@@ -38,7 +38,7 @@ public enum HttpStatus {
        /**
         * The status line, as defined by RFC2616.
         * 
-        * @see https://www.rfc-editor.org/rfc/rfc2616#section-6.1
+        * @see "https://www.rfc-editor.org/rfc/rfc2616#section-6.1"
         */
        public String getStatusLine(String httpVersion) {
                return httpVersion + " " + code + " " + reasonPhrase;
index 6aefc161724c7f5bbfb8cf31753ff0ef63ee9c2d..e339edeefbcdea59e22c25e8e2afd9adfd179c91 100644 (file)
@@ -10,7 +10,7 @@ import javax.naming.ldap.LdapName;
 /**
  * An object that can be identified with an X.500 distinguished name.
  * 
- * @see https://tools.ietf.org/html/rfc1779
+ * @see "https://tools.ietf.org/html/rfc1779"
  */
 public interface Distinguished {
        /** The related distinguished name. */
index b818b06d960603d05625f8c13fa11844b0141679..c664aa3cafb4a7178c3db4de8e2eda302b56e55a 100644 (file)
@@ -6,7 +6,7 @@ import org.eclipse.swt.events.MouseListener;
 /**
  * {@link MouseListener#mouseDoubleClick(MouseEvent)} as a functional interface
  * in order to use as a short lambda expression in UI code.
- * {@link MouseListener#mouseDownouseEvent)} and
+ * {@link MouseListener#mouseDown(MouseEvent)} and
  * {@link MouseListener#mouseUp(MouseEvent)} do nothing by default.
  */
 @FunctionalInterface