Merge pull request #666 from apache/javadoc-updates

Minor Javdoc cleanup
apache · Sep 13, 2024 · 1b8131b · 1b8131b
2 parents bea15f3 + 8b0d55c
commit 1b8131b
Show file tree

Hide file tree

Showing 29 changed files with 39 additions and 61 deletions.
diff --git a/pom.xml b/pom.xml
@@ -530,7 +530,6 @@
               <id>attach-javadocs</id>
               <goals>
                 <goal>jar</goal>
-                <goal>test-jar</goal>
               </goals>
             </execution>
           </executions>

diff --git a/...main/java/org/apache/directory/scim/core/repository/annotations/ProcessingExtensions.java b/...main/java/org/apache/directory/scim/core/repository/annotations/ProcessingExtensions.java
@@ -33,7 +33,7 @@
 public @interface ProcessingExtensions {
 
   /**
-   * An array of one or more {@link ExtendWith @ExtendWith} declarations.
+   * An array of one or more {@link ScimProcessingExtension @ScimProcessingExtension} declarations.
    */
   ScimProcessingExtension[] value();
 

diff --git a/scim-server/src/main/java/org/apache/directory/scim/server/rest/GroupResourceImpl.java b/scim-server/src/main/java/org/apache/directory/scim/server/rest/GroupResourceImpl.java
@@ -17,9 +17,6 @@
 * under the License.
 */
 
-/**
- * 
- */
 package org.apache.directory.scim.server.rest;
 
 import jakarta.enterprise.context.ApplicationScoped;

diff --git a/scim-server/src/main/java/org/apache/directory/scim/server/rest/UserResourceImpl.java b/scim-server/src/main/java/org/apache/directory/scim/server/rest/UserResourceImpl.java
@@ -17,9 +17,6 @@
 * under the License.
 */
 
-/**
- * 
- */
 package org.apache.directory.scim.server.rest;
 
 import jakarta.enterprise.context.ApplicationScoped;

diff --git a/...c-protocol/src/main/java/org/apache/directory/scim/protocol/BaseResourceTypeResource.java b/...c-protocol/src/main/java/org/apache/directory/scim/protocol/BaseResourceTypeResource.java
@@ -61,7 +61,7 @@ public interface BaseResourceTypeResource<T> {
    *      retrieving known resources</a>
    * @return
    * @throws ScimException
-   * @throws UnableToRetrieveResourceException
+   * @throws ResourceException
    */
   @GET
   @Path("{id}")

diff --git a/...pec/scim-spec-protocol/src/main/java/org/apache/directory/scim/protocol/BulkResource.java b/...pec/scim-spec-protocol/src/main/java/org/apache/directory/scim/protocol/BulkResource.java
@@ -46,12 +46,12 @@
 * From SCIM Protocol Specification, section 3, page 9
 * 
 * @see <a href="https://tools.ietf.org/html/rfc7644#section-3.2">Scim spec section 3.2</a>
-* 
+* <p>
 * Resource Endpoint         Operations             Description
- -------- ---------------- ---------------------- --------------------
-   Bulk     /Bulk            POST (Section 3.7)     Bulk updates to one
-                                                    or more resources.
-
+* -------- ---------------- ---------------------- --------------------
+*    Bulk     /Bulk            POST (Section 3.7)     Bulk updates to one
+*                                                     or more resources.
+* </pre></code>
 * @author chrisharm
 *
 */

diff --git a/...ec/scim-spec-protocol/src/main/java/org/apache/directory/scim/protocol/GroupResource.java b/...ec/scim-spec-protocol/src/main/java/org/apache/directory/scim/protocol/GroupResource.java
@@ -29,7 +29,7 @@
 * From SCIM Protocol Specification, section 3, page 9
 * 
 * @see <a href="https://tools.ietf.org/html/rfc7644#section-3.2">Scim spec section 3.2</a>
-* 
+* <p>
 * Resource Endpoint         Operations             Description
  -------- ---------------- ---------------------- --------------------
  Group    /Groups          GET (Section 3.4.1),   Retrieve, add,

diff --git a/...spec-protocol/src/main/java/org/apache/directory/scim/protocol/ResourceTypesResource.java b/...spec-protocol/src/main/java/org/apache/directory/scim/protocol/ResourceTypesResource.java
@@ -40,15 +40,15 @@
  * 
  * @see <a href="https://tools.ietf.org/html/rfc7644#section-4">Scim spec
  *      section 4</a>
- * 
+ * <p>
  *      /ResourceTypes An HTTP GET to this endpoint is used to discover the
  *      types of resources available on a SCIM service provider (e.g., Users and
  *      Groups). Each resource type defines the endpoints, the core schema URI
  *      that defines the resource, and any supported schema extensions. The
  *      attributes defining a resource type can be found in Section 6 of
  *      [RFC7643], and an example representation can be found in Section 8.6 of
  *      [RFC7643].
- * 
+ * <p>
  *      In cases where a request is for a specific "ResourceType" or "Schema",
  *      the single JSON object is returned in the same way that a single User or
  *      Group is retrieved, as per Section 3.4.1. When returning multiple

diff --git a/...c/scim-spec-protocol/src/main/java/org/apache/directory/scim/protocol/SchemaResource.java b/...c/scim-spec-protocol/src/main/java/org/apache/directory/scim/protocol/SchemaResource.java
@@ -40,20 +40,20 @@
  * From SCIM Protocol Specification, section 4, page 74
  * 
  * @see <a href="https://tools.ietf.org/html/rfc7644#section-4">Scim spec section 4</a>
- * 
+ * <p>
  *      /Schemas An HTTP GET to this endpoint is used to retrieve information
  *      about resource schemas supported by a SCIM service provider. An HTTP GET
  *      to the endpoint "/Schemas" SHALL return all supported schemas in
  *      ListResponse format (see Figure 3). Individual schema definitions can be
  *      returned by appending the schema URI to the /Schemas endpoint. For
  *      example:
- * 
+ * <p>
  *      /Schemas/urn:ietf:params:scim:schemas:core:2.0:User
- * 
+ * <p>
  *      The contents of each schema returned are described in Section 7 of
  *      [RFC7643]. An example representation of SCIM schemas may be found in
  *      Section 8.7 of [RFC7643].
- * 
+ * <p>
  *      In cases where a request is for a specific "ResourceType" or "Schema",
  *      the single JSON object is returned in the same way that a single User or
  *      Group is retrieved, as per Section 3.4.1. When returning multiple

diff --git a/...c/scim-spec-protocol/src/main/java/org/apache/directory/scim/protocol/SearchResource.java b/...c/scim-spec-protocol/src/main/java/org/apache/directory/scim/protocol/SearchResource.java
@@ -44,7 +44,7 @@
 * From SCIM Protocol Specification, section 3, page 9
 * 
 * @see <a href="https://tools.ietf.org/html/rfc7644#section-3.2">Scim spec section 3.2</a>
-* 
+* <p>
 * Resource Endpoint         Operations             Description
  -------- ---------------- ---------------------- --------------------
    Search   [prefix]/.search POST (Section 3.4.3)   Search from system

diff --git a/...pec/scim-spec-protocol/src/main/java/org/apache/directory/scim/protocol/SelfResource.java b/...pec/scim-spec-protocol/src/main/java/org/apache/directory/scim/protocol/SelfResource.java
@@ -54,7 +54,7 @@
  * From SCIM Protocol Specification, section 3, page 9
  * 
  * @see <a href="https://tools.ietf.org/html/rfc7644#section-3.2">Scim spec section 3.2</a>
- * 
+ * <p>
  * Resource Endpoint         Operations             Description
    -------- ---------------- ---------------------- --------------------
    Self     /Me              GET, POST, PUT, PATCH, Alias for operations
@@ -79,7 +79,7 @@ public interface SelfResource {
    * @see <a href="https://tools.ietf.org/html/rfc7644#section-3.4.1">Scim spec,
    *      retrieving known resources</a>
    * @return
-   * @throws UnableToRetrieveResourceException 
+   * @throws ResourceException
    */
   @GET
   @Produces({SCIM_CONTENT_TYPE, APPLICATION_JSON})

diff --git a/...tocol/src/main/java/org/apache/directory/scim/protocol/ServiceProviderConfigResource.java b/...tocol/src/main/java/org/apache/directory/scim/protocol/ServiceProviderConfigResource.java
@@ -41,7 +41,7 @@
 * From SCIM Protocol Specification, section 4, page 73
 * 
 * @see <a href="https://tools.ietf.org/html/rfc7644#section-4">Scim spec section 4</a>
-* 
+* <p>
 * /ServiceProviderConfig
 *      An HTTP GET to this endpoint will return a JSON structure that
 *      describes the SCIM specification features available on a service

diff --git a/...pec/scim-spec-protocol/src/main/java/org/apache/directory/scim/protocol/UserResource.java b/...pec/scim-spec-protocol/src/main/java/org/apache/directory/scim/protocol/UserResource.java
@@ -29,7 +29,7 @@
  * From SCIM Protocol Specification, section 3, page 9
  * 
  * @see <a href="https://tools.ietf.org/html/rfc7644#section-3.2">Scim spec section 3.2</a>
- * 
+ * <p>
  * Resource Endpoint         Operations             Description
    -------- ---------------- ---------------------- --------------------
    User     /Users           GET (Section 3.4.1),   Retrieve, add,

diff --git a/...im-spec-protocol/src/main/java/org/apache/directory/scim/protocol/data/SearchRequest.java b/...im-spec-protocol/src/main/java/org/apache/directory/scim/protocol/data/SearchRequest.java
@@ -40,8 +40,8 @@
 
 /**
  * See Section 3.4.3 Querying Resources Using HTTP POST
- * (https://tools.ietf.org/html/rfc7644#section-3.4.3)
- * 
+ * (<a href="https://tools.ietf.org/html/rfc7644#section-3.4.3">RFC 7644 section 3.4.3</a>)
+ *
  * @author crh5255
  *
  */

diff --git a/scim-spec/scim-spec-schema/src/main/java/org/apache/directory/scim/spec/filter/Filter.java b/scim-spec/scim-spec-schema/src/main/java/org/apache/directory/scim/spec/filter/Filter.java
@@ -35,7 +35,7 @@
 
 /**
  * 
- * @author Steve Moyer <[email protected]>
+ * @author Steve Moyer {@literal <[email protected]>}
  */
 @Data
 @Slf4j

diff --git a/...spec-schema/src/main/java/org/apache/directory/scim/spec/filter/FilterParseException.java b/...spec-schema/src/main/java/org/apache/directory/scim/spec/filter/FilterParseException.java
@@ -17,9 +17,6 @@
 * under the License.
 */
 
-/**
- * 
- */
 package org.apache.directory.scim.spec.filter;
 
 /**

diff --git a/...a/src/main/java/org/apache/directory/scim/spec/phonenumber/PhoneNumberParseException.java b/...a/src/main/java/org/apache/directory/scim/spec/phonenumber/PhoneNumberParseException.java
@@ -17,9 +17,6 @@
 * under the License.
 */
 
-/**
- * 
- */
 package org.apache.directory.scim.spec.phonenumber;
 
 /**

diff --git a/...spec/scim-spec-schema/src/main/java/org/apache/directory/scim/spec/resources/Address.java b/...spec/scim-spec-schema/src/main/java/org/apache/directory/scim/spec/resources/Address.java
@@ -31,7 +31,7 @@
 import lombok.EqualsAndHashCode;
 
 /**
- * Scim core schema, <a href="https://tools.ietf.org/html/rfc7643#section-4.1.2>section 4.1.2</a>
+ * Scim core schema, <a href="https://tools.ietf.org/html/rfc7643#section-4.1.2">section 4.1.2</a>
  *
  */
 @XmlType(name = "address")

diff --git a/scim-spec/scim-spec-schema/src/main/java/org/apache/directory/scim/spec/resources/Email.java b/scim-spec/scim-spec-schema/src/main/java/org/apache/directory/scim/spec/resources/Email.java
@@ -31,7 +31,7 @@
 import lombok.EqualsAndHashCode;
 
 /**
- * Scim core schema, <a href="https://tools.ietf.org/html/rfc7643#section-4.1.2>section 4.1.2</a>
+ * Scim core schema, <a href="https://tools.ietf.org/html/rfc7643#section-4.1.2">section 4.1.2</a>
  *
  */
 @XmlType

diff --git a/.../scim-spec-schema/src/main/java/org/apache/directory/scim/spec/resources/Entitlement.java b/.../scim-spec-schema/src/main/java/org/apache/directory/scim/spec/resources/Entitlement.java
@@ -31,7 +31,7 @@
 import lombok.EqualsAndHashCode;
 
 /**
- * Scim core schema, <a href="https://tools.ietf.org/html/rfc7643#section-4.1.2>section 4.1.2</a>
+ * Scim core schema, <a href="https://tools.ietf.org/html/rfc7643#section-4.1.2">section 4.1.2</a>
  *
  */
 @XmlType

diff --git a/scim-spec/scim-spec-schema/src/main/java/org/apache/directory/scim/spec/resources/Im.java b/scim-spec/scim-spec-schema/src/main/java/org/apache/directory/scim/spec/resources/Im.java
@@ -31,7 +31,7 @@
 import lombok.EqualsAndHashCode;
 
 /**
- * Scim core schema, <a href="https://tools.ietf.org/html/rfc7643#section-4.1.2>section 4.1.2</a>
+ * Scim core schema, <a href="https://tools.ietf.org/html/rfc7643#section-4.1.2">section 4.1.2</a>
  *
  */
 @XmlType

diff --git a/.../scim-spec-schema/src/main/java/org/apache/directory/scim/spec/resources/PhoneNumber.java b/.../scim-spec-schema/src/main/java/org/apache/directory/scim/spec/resources/PhoneNumber.java
@@ -17,9 +17,6 @@
 * under the License.
 */
 
-/**
- * 
- */
 package org.apache.directory.scim.spec.resources;
 
 import java.io.Serializable;
@@ -58,7 +55,7 @@
 
 /**
  * Scim core schema, <a
- * href="https://tools.ietf.org/html/rfc7643#section-4.1.2>section 4.1.2</a>
+ * href="https://tools.ietf.org/html/rfc7643#section-4.1.2">section 4.1.2</a>
  *
  */
 

diff --git a/scim-spec/scim-spec-schema/src/main/java/org/apache/directory/scim/spec/resources/Photo.java b/scim-spec/scim-spec-schema/src/main/java/org/apache/directory/scim/spec/resources/Photo.java
@@ -31,7 +31,7 @@
 import lombok.EqualsAndHashCode;
 
 /**
- * Scim core schema, <a href="https://tools.ietf.org/html/rfc7643#section-4.1.2>section 4.1.2</a>
+ * Scim core schema, <a href="https://tools.ietf.org/html/rfc7643#section-4.1.2">section 4.1.2</a>
  *
  */
 @XmlType

diff --git a/scim-spec/scim-spec-schema/src/main/java/org/apache/directory/scim/spec/resources/Role.java b/scim-spec/scim-spec-schema/src/main/java/org/apache/directory/scim/spec/resources/Role.java
@@ -31,7 +31,7 @@
 import lombok.EqualsAndHashCode;
 
 /**
- * Scim core schema, <a href="https://tools.ietf.org/html/rfc7643#section-4.1.2>section 4.1.2</a>
+ * Scim core schema, <a href="https://tools.ietf.org/html/rfc7643#section-4.1.2">section 4.1.2</a>
  *
  */
 @XmlType

diff --git a/...m-spec-schema/src/main/java/org/apache/directory/scim/spec/resources/X509Certificate.java b/...m-spec-schema/src/main/java/org/apache/directory/scim/spec/resources/X509Certificate.java
@@ -30,7 +30,7 @@
 import lombok.Data;
 
 /**
- * Scim core schema, <a href="https://tools.ietf.org/html/rfc7643#section-4.1.2>section 4.1.2</a>
+ * Scim core schema, <a href="https://tools.ietf.org/html/rfc7643#section-4.1.2">section 4.1.2</a>
  *
  */
 @XmlType

diff --git a/scim-spec/scim-spec-schema/src/main/java/org/apache/directory/scim/spec/schema/Mapper.java b/scim-spec/scim-spec-schema/src/main/java/org/apache/directory/scim/spec/schema/Mapper.java
@@ -17,9 +17,6 @@
 * under the License.
 */
 
-/**
- * 
- */
 package org.apache.directory.scim.spec.schema;
 
 import java.time.Instant;

diff --git a/scim-spec/scim-spec-schema/src/main/java/org/apache/directory/scim/spec/schema/Meta.java b/scim-spec/scim-spec-schema/src/main/java/org/apache/directory/scim/spec/schema/Meta.java
@@ -37,10 +37,10 @@
 /**
  * Defines the structure of the meta attribute for all SCIM resources as defined
  * by section 3.1 of the SCIM schema specification. See
- * https://tools.ietf.org/html/draft-ietf-scim-core-schema-17#section-3.1 for more
+ * <a href="https://datatracker.ietf.org/doc/html/rfc7643#section-3.1">RFC 7643 section 3.1</a> for more
  * details.
- * 
- * @author Steve Moyer <[email protected]>
+ *
+ * @author Steve Moyer {@literal <[email protected]>}
  */
 @XmlType(name = "meta")
 @XmlAccessorType(XmlAccessType.NONE)

diff --git a/scim-spec/scim-spec-schema/src/main/java/org/apache/directory/scim/spec/schema/Schema.java b/scim-spec/scim-spec-schema/src/main/java/org/apache/directory/scim/spec/schema/Schema.java
@@ -35,10 +35,10 @@
 /**
  * Defines the structure of the SCIM schemas as defined by section 7 of the SCIM
  * schema specification. See
- * https://tools.ietf.org/html/draft-ietf-scim-core-schema-17#section-7 for more
+ * <a href="https://datatracker.ietf.org/doc/html/rfc7643#section-7">RFC 7643 section 7</a> for more
  * details.
- * 
- * @author Steve Moyer <[email protected]>
+ *
+ * @author Steve Moyer {@literal <[email protected]>}
  */
 @XmlRootElement(name = "schema")
 @XmlAccessorType(XmlAccessType.NONE)
@@ -55,10 +55,10 @@ public class Schema implements AttributeContainer {
   /**
    * Defines the structure of attributes included in SCIM schemas as defined by
    * section 7 of the SCIM schema specification. See
-   * https://tools.ietf.org/html/draft-ietf-scim-core-schema-17#section-7 for more
+   * <a href="https://datatracker.ietf.org/doc/html/rfc7643#section-7">RFC 7643 section 7</a> for more
    * details.
-   * 
-   * @author Steve Moyer <[email protected]>
+   *
+   * @author Steve Moyer {@literal <[email protected]>}
    */
   @XmlType(name = "attribute")
   @XmlAccessorType(XmlAccessType.NONE)

diff --git a/...c-schema/src/test/java/org/apache/directory/scim/spec/filter/AbstractLexerParserTest.java b/...c-schema/src/test/java/org/apache/directory/scim/spec/filter/AbstractLexerParserTest.java
@@ -17,9 +17,6 @@
 * under the License.
 */
 
-/**
- * 
- */
 package org.apache.directory.scim.spec.filter;
 
 import org.apache.commons.lang3.ArrayUtils;
-Original file line number
+Diff line change
@@ Expand Up / @@ -17,9 +17,6 @@ @@
     * under the License.
     */
-    /**
-     *
-     */
     package org.apache.directory.scim.server.rest;
     import jakarta.enterprise.context.ApplicationScoped;
@@ Expand Down @@