Skip to content

Commit

Permalink
Minor Javdoc cleanup
Browse files Browse the repository at this point in the history
Mostly the result of IntelliJ inspections and seeing warnings when Javadoc runs at release time
  • Loading branch information
bdemers committed Sep 8, 2024
1 parent bea15f3 commit 8b0d55c
Show file tree
Hide file tree
Showing 29 changed files with 39 additions and 61 deletions.
1 change: 0 additions & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -530,7 +530,6 @@
<id>attach-javadocs</id>
<goals>
<goal>jar</goal>
<goal>test-jar</goal>
</goals>
</execution>
</executions>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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();

Expand Down
Original file line number Diff 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
Original file line number Diff 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
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ public interface BaseResourceTypeResource<T> {
* retrieving known resources</a>
* @return
* @throws ScimException
* @throws UnableToRetrieveResourceException
* @throws ResourceException
*/
@GET
@Path("{id}")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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})
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
*
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@

/**
*
* @author Steve Moyer <[email protected]>
* @author Steve Moyer {@literal <[email protected]>}
*/
@Data
@Slf4j
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,6 @@
* under the License.
*/

/**
*
*/
package org.apache.directory.scim.spec.filter;

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,6 @@
* under the License.
*/

/**
*
*/
package org.apache.directory.scim.spec.phonenumber;

/**
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,6 @@
* under the License.
*/

/**
*
*/
package org.apache.directory.scim.spec.resources;

import java.io.Serializable;
Expand Down Expand Up @@ -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>
*
*/

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,6 @@
* under the License.
*/

/**
*
*/
package org.apache.directory.scim.spec.schema;

import java.time.Instant;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,6 @@
* under the License.
*/

/**
*
*/
package org.apache.directory.scim.spec.filter;

import org.apache.commons.lang3.ArrayUtils;
Expand Down

0 comments on commit 8b0d55c

Please sign in to comment.