From f1ac0c0533b0e4e3dd9c7f9507031a074d5f44ed Mon Sep 17 00:00:00 2001 From: Mathieu Baudier Date: Sat, 15 Oct 2022 10:22:55 +0200 Subject: [PATCH] Fix Javadocs --- .../src/org/argeo/cms/ui/forms/FormUtils.java | 4 ++-- .../src/org/argeo/cms/ui/jcr/model/RepositoriesElem.java | 2 +- .../argeo/eclipse/ui/jcr/lists/NodeViewerComparator.java | 2 +- .../org/argeo/eclipse/ui/jcr/lists/RowViewerComparator.java | 2 +- jcr/org.argeo.cms.jcr/src/org/argeo/jcr/Jcr.java | 1 - .../src/org/argeo/api/acr/AttributeFormatter.java | 5 ++--- org.argeo.api.acr/src/org/argeo/api/acr/ContentName.java | 2 +- .../src/org/argeo/api/acr/CrAttributeType.java | 4 ++-- org.argeo.api.acr/src/org/argeo/api/acr/DName.java | 4 ++-- .../src/org/argeo/api/uuid/AbstractAsyncUuidFactory.java | 2 +- .../src/org/argeo/api/uuid/AbstractUuidFactory.java | 4 ++-- .../src/org/argeo/api/uuid/BasicNameUuid.java | 2 +- .../src/org/argeo/api/uuid/ConcurrentTimeUuidState.java | 3 ++- .../src/org/argeo/api/uuid/ConcurrentUuidFactory.java | 2 +- org.argeo.api.uuid/src/org/argeo/api/uuid/GUID.java | 4 ++-- .../src/org/argeo/api/uuid/MacAddressUuidFactory.java | 2 +- org.argeo.api.uuid/src/org/argeo/api/uuid/UuidFactory.java | 6 +++--- .../src/org/argeo/cms/internal/osgi/GogoShellKiller.java | 2 +- org.argeo.util/src/org/argeo/util/http/HttpStatus.java | 4 ++-- org.argeo.util/src/org/argeo/util/naming/Distinguished.java | 2 +- .../src/org/argeo/cms/swt/MouseDoubleClick.java | 2 +- 21 files changed, 30 insertions(+), 31 deletions(-) diff --git a/jcr/org.argeo.cms.jcr.ui/src/org/argeo/cms/ui/forms/FormUtils.java b/jcr/org.argeo.cms.jcr.ui/src/org/argeo/cms/ui/forms/FormUtils.java index ef49c8ae5..eeafabbe1 100644 --- a/jcr/org.argeo.cms.jcr.ui/src/org/argeo/cms/ui/forms/FormUtils.java +++ b/jcr/org.argeo.cms.jcr.ui/src/org/argeo/cms/ui/forms/FormUtils.java @@ -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(); diff --git a/jcr/org.argeo.cms.jcr.ui/src/org/argeo/cms/ui/jcr/model/RepositoriesElem.java b/jcr/org.argeo.cms.jcr.ui/src/org/argeo/cms/ui/jcr/model/RepositoriesElem.java index 742800b0b..8c40f8b37 100644 --- a/jcr/org.argeo.cms.jcr.ui/src/org/argeo/cms/ui/jcr/model/RepositoriesElem.java +++ b/jcr/org.argeo.cms.jcr.ui/src/org/argeo/cms/ui/jcr/model/RepositoriesElem.java @@ -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 diff --git a/jcr/org.argeo.cms.jcr.ui/src/org/argeo/eclipse/ui/jcr/lists/NodeViewerComparator.java b/jcr/org.argeo.cms.jcr.ui/src/org/argeo/eclipse/ui/jcr/lists/NodeViewerComparator.java index 341b3abee..d9904605f 100644 --- a/jcr/org.argeo.cms.jcr.ui/src/org/argeo/eclipse/ui/jcr/lists/NodeViewerComparator.java +++ b/jcr/org.argeo.cms.jcr.ui/src/org/argeo/eclipse/ui/jcr/lists/NodeViewerComparator.java @@ -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) { diff --git a/jcr/org.argeo.cms.jcr.ui/src/org/argeo/eclipse/ui/jcr/lists/RowViewerComparator.java b/jcr/org.argeo.cms.jcr.ui/src/org/argeo/eclipse/ui/jcr/lists/RowViewerComparator.java index 455fb0dcd..60d637d61 100644 --- a/jcr/org.argeo.cms.jcr.ui/src/org/argeo/eclipse/ui/jcr/lists/RowViewerComparator.java +++ b/jcr/org.argeo.cms.jcr.ui/src/org/argeo/eclipse/ui/jcr/lists/RowViewerComparator.java @@ -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) { diff --git a/jcr/org.argeo.cms.jcr/src/org/argeo/jcr/Jcr.java b/jcr/org.argeo.cms.jcr/src/org/argeo/jcr/Jcr.java index 1936f2398..49b008d70 100644 --- a/jcr/org.argeo.cms.jcr/src/org/argeo/jcr/Jcr.java +++ b/jcr/org.argeo.cms.jcr/src/org/argeo/jcr/Jcr.java @@ -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) { diff --git a/org.argeo.api.acr/src/org/argeo/api/acr/AttributeFormatter.java b/org.argeo.api.acr/src/org/argeo/api/acr/AttributeFormatter.java index 41600331a..c7023f1a3 100644 --- a/org.argeo.api.acr/src/org/argeo/api/acr/AttributeFormatter.java +++ b/org.argeo.api.acr/src/org/argeo/api/acr/AttributeFormatter.java @@ -4,9 +4,8 @@ package org.argeo.api.acr; * An attribute type MUST consistently parse a string to an object so that * parse(obj.toString()).equals(obj) is verified. * {@link #format(Object)} can be overridden to provide more efficient - * implementations but the returned - * String MUST be the same, that is format(obj).equals(obj.toString()) - * is verified. + * implementations but the returned String MUST be the same, that + * is format(obj).equals(obj.toString()) is verified. */ public interface AttributeFormatter { /** Parses a String to a Java object. */ diff --git a/org.argeo.api.acr/src/org/argeo/api/acr/ContentName.java b/org.argeo.api.acr/src/org/argeo/api/acr/ContentName.java index fdeb60776..113f98da0 100644 --- a/org.argeo.api.acr/src/org/argeo/api/acr/ContentName.java +++ b/org.argeo.api.acr/src/org/argeo/api/acr/ContentName.java @@ -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 diff --git a/org.argeo.api.acr/src/org/argeo/api/acr/CrAttributeType.java b/org.argeo.api.acr/src/org/argeo/api/acr/CrAttributeType.java index 4dae9221c..55ad079ec 100644 --- a/org.argeo.api.acr/src/org/argeo/api/acr/CrAttributeType.java +++ b/org.argeo.api.acr/src/org/argeo/api/acr/CrAttributeType.java @@ -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 - * String. + * String. */ 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) diff --git a/org.argeo.api.acr/src/org/argeo/api/acr/DName.java b/org.argeo.api.acr/src/org/argeo/api/acr/DName.java index 162ae919f..be065a8d9 100644 --- a/org.argeo.api.acr/src/org/argeo/api/acr/DName.java +++ b/org.argeo.api.acr/src/org/argeo/api/acr/DName.java @@ -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 diff --git a/org.argeo.api.uuid/src/org/argeo/api/uuid/AbstractAsyncUuidFactory.java b/org.argeo.api.uuid/src/org/argeo/api/uuid/AbstractAsyncUuidFactory.java index 52becc85a..fc1c931ff 100644 --- a/org.argeo.api.uuid/src/org/argeo/api/uuid/AbstractAsyncUuidFactory.java +++ b/org.argeo.api.uuid/src/org/argeo/api/uuid/AbstractAsyncUuidFactory.java @@ -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) { diff --git a/org.argeo.api.uuid/src/org/argeo/api/uuid/AbstractUuidFactory.java b/org.argeo.api.uuid/src/org/argeo/api/uuid/AbstractUuidFactory.java index 1bbc4391f..4f2cf3765 100644 --- a/org.argeo.api.uuid/src/org/argeo/api/uuid/AbstractUuidFactory.java +++ b/org.argeo.api.uuid/src/org/argeo/api/uuid/AbstractUuidFactory.java @@ -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; diff --git a/org.argeo.api.uuid/src/org/argeo/api/uuid/BasicNameUuid.java b/org.argeo.api.uuid/src/org/argeo/api/uuid/BasicNameUuid.java index b883e0dcb..c9f130df9 100644 --- a/org.argeo.api.uuid/src/org/argeo/api/uuid/BasicNameUuid.java +++ b/org.argeo.api.uuid/src/org/argeo/api/uuid/BasicNameUuid.java @@ -13,7 +13,7 @@ public class BasicNameUuid extends TypedUuid { } /** - * Always returns true since it is unknown from which values it was + * Always returns true since it is unknown from which values it was * constructed.. */ @Override diff --git a/org.argeo.api.uuid/src/org/argeo/api/uuid/ConcurrentTimeUuidState.java b/org.argeo.api.uuid/src/org/argeo/api/uuid/ConcurrentTimeUuidState.java index 8131df8ee..6dbd403dd 100644 --- a/org.argeo.api.uuid/src/org/argeo/api/uuid/ConcurrentTimeUuidState.java +++ b/org.argeo.api.uuid/src/org/argeo/api/uuid/ConcurrentTimeUuidState.java @@ -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 { diff --git a/org.argeo.api.uuid/src/org/argeo/api/uuid/ConcurrentUuidFactory.java b/org.argeo.api.uuid/src/org/argeo/api/uuid/ConcurrentUuidFactory.java index f2bd43689..130a90a84 100644 --- a/org.argeo.api.uuid/src/org/argeo/api/uuid/ConcurrentUuidFactory.java +++ b/org.argeo.api.uuid/src/org/argeo/api/uuid/ConcurrentUuidFactory.java @@ -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()); diff --git a/org.argeo.api.uuid/src/org/argeo/api/uuid/GUID.java b/org.argeo.api.uuid/src/org/argeo/api/uuid/GUID.java index a9a5af17d..0775cbf75 100644 --- a/org.argeo.api.uuid/src/org/argeo/api/uuid/GUID.java +++ b/org.argeo.api.uuid/src/org/argeo/api/uuid/GUID.java @@ -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 { *
  • P: (1db31359-bdd8-5a0f-b672-30c247d582c5)
    • * * - * @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; diff --git a/org.argeo.api.uuid/src/org/argeo/api/uuid/MacAddressUuidFactory.java b/org.argeo.api.uuid/src/org/argeo/api/uuid/MacAddressUuidFactory.java index f9004ce3e..31fe37831 100644 --- a/org.argeo.api.uuid/src/org/argeo/api/uuid/MacAddressUuidFactory.java +++ b/org.argeo.api.uuid/src/org/argeo/api/uuid/MacAddressUuidFactory.java @@ -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() { diff --git a/org.argeo.api.uuid/src/org/argeo/api/uuid/UuidFactory.java b/org.argeo.api.uuid/src/org/argeo/api/uuid/UuidFactory.java index 4ab6c2e4b..ee5aa6994 100644 --- a/org.argeo.api.uuid/src/org/argeo/api/uuid/UuidFactory.java +++ b/org.argeo.api.uuid/src/org/argeo/api/uuid/UuidFactory.java @@ -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 { @@ -184,7 +184,7 @@ public interface UuidFactory extends Supplier { * 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 { * 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. */ diff --git a/org.argeo.cms/src/org/argeo/cms/internal/osgi/GogoShellKiller.java b/org.argeo.cms/src/org/argeo/cms/internal/osgi/GogoShellKiller.java index a8c901644..9de7a4fd1 100644 --- a/org.argeo.cms/src/org/argeo/cms/internal/osgi/GogoShellKiller.java +++ b/org.argeo.cms/src/org/argeo/cms/internal/osgi/GogoShellKiller.java @@ -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 { diff --git a/org.argeo.util/src/org/argeo/util/http/HttpStatus.java b/org.argeo.util/src/org/argeo/util/http/HttpStatus.java index 8fb109bd4..11e0a3645 100644 --- a/org.argeo.util/src/org/argeo/util/http/HttpStatus.java +++ b/org.argeo.util/src/org/argeo/util/http/HttpStatus.java @@ -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; diff --git a/org.argeo.util/src/org/argeo/util/naming/Distinguished.java b/org.argeo.util/src/org/argeo/util/naming/Distinguished.java index 6aefc1617..e339edeef 100644 --- a/org.argeo.util/src/org/argeo/util/naming/Distinguished.java +++ b/org.argeo.util/src/org/argeo/util/naming/Distinguished.java @@ -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. */ diff --git a/swt/org.argeo.cms.swt/src/org/argeo/cms/swt/MouseDoubleClick.java b/swt/org.argeo.cms.swt/src/org/argeo/cms/swt/MouseDoubleClick.java index b818b06d9..c664aa3ca 100644 --- a/swt/org.argeo.cms.swt/src/org/argeo/cms/swt/MouseDoubleClick.java +++ b/swt/org.argeo.cms.swt/src/org/argeo/cms/swt/MouseDoubleClick.java @@ -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 -- 2.30.2