[sling-org-apache-sling-junit-core] branch master updated: trivial: javadoc fixes

[js...@apache.org]

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

jsedding pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-junit-core.git


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

commit 1f4c074f850c2d64aae7eda333087ce19b413cc7
Author: Julian Sedding <js...@apache.org>
AuthorDate: Thu Jun 24 22:15:45 2021 +0200

    trivial: javadoc fixes
---
 src/main/java/org/apache/sling/junit/jupiter/osgi/Service.java      | 6 ++++++
 .../org/apache/sling/junit/jupiter/osgi/ServiceCardinality.java     | 2 +-
 .../sling/junit/jupiter/osgi/impl/TypeBasedParameterResolver.java   | 2 +-
 3 files changed, 8 insertions(+), 2 deletions(-)

diff --git a/src/main/java/org/apache/sling/junit/jupiter/osgi/Service.java b/src/main/java/org/apache/sling/junit/jupiter/osgi/Service.java
index 9705197..dbd59d7 100644
--- a/src/main/java/org/apache/sling/junit/jupiter/osgi/Service.java
+++ b/src/main/java/org/apache/sling/junit/jupiter/osgi/Service.java
@@ -67,17 +67,23 @@ public @interface Service {
      * <br>
      * May be omitted if the annotation is used to annotate a method parameter, as the service type can
      * be inferred from the parameter's type.
+     *
+     * @return the service interface or class
      */
     Class<?> value() default Object.class;
 
     /**
      * An optional filter expression conforming to the LDAP filter syntax used in OSGi {@link Filter}s.
+     *
+     * @return the filter expression or an empty string if none is specified
      */
     String filter() default "";
 
     /**
      * Whether or not injection fails in the absence of a suitable service.
      *
+     * @return the desired cardinality for the injected service
+     *
      * @see ServiceCardinality
      */
     ServiceCardinality cardinality() default ServiceCardinality.AUTO;
diff --git a/src/main/java/org/apache/sling/junit/jupiter/osgi/ServiceCardinality.java b/src/main/java/org/apache/sling/junit/jupiter/osgi/ServiceCardinality.java
index a15a479..5081fd3 100644
--- a/src/main/java/org/apache/sling/junit/jupiter/osgi/ServiceCardinality.java
+++ b/src/main/java/org/apache/sling/junit/jupiter/osgi/ServiceCardinality.java
@@ -20,7 +20,7 @@ package org.apache.sling.junit.jupiter.osgi;
 
 /**
  * The cardinality of a service being injected is controlled via the type of the injected
- * parameter and additionally via the {@link @Service} annotation's {@code cardinality}
+ * parameter and additionally via the {@link Service @Service} annotation's {@code cardinality}
  * attribute.
  * <br>
  * The cardinality can be either {@code OPTIONAL} or {@code MANDATORY}. {@code OPTIONAL}
diff --git a/src/main/java/org/apache/sling/junit/jupiter/osgi/impl/TypeBasedParameterResolver.java b/src/main/java/org/apache/sling/junit/jupiter/osgi/impl/TypeBasedParameterResolver.java
index 30aca67..6bf311b 100644
--- a/src/main/java/org/apache/sling/junit/jupiter/osgi/impl/TypeBasedParameterResolver.java
+++ b/src/main/java/org/apache/sling/junit/jupiter/osgi/impl/TypeBasedParameterResolver.java
@@ -33,7 +33,7 @@ import static org.apache.sling.junit.jupiter.osgi.impl.ReflectionHelper.paramete
  * {@link #resolveParameter(ParameterContext, ExtensionContext, Type)}, the supported parameter type is
  * inferred from the classes type-argument {@code T}.
  *
- * @param <T>
+ * @param <T> the type to be provided by the parameter resolver
  */
 public abstract class TypeBasedParameterResolver<T> extends AbstractTypeBasedParameterResolver {