Merge pull request #26239 from marcwrobel/typos-extensions

Fix and improve javadoc in extensions projects

extensions/agroal/deployment/src/main/java/io/quarkus/agroal/deployment/AgroalProcessor.java

@@ -231,7 +231,7 @@ void generateDataSourceBeans(AgroalRecorder recorder,
                     .setRuntimeInit()
                     .unremovable()
                     // pass the runtime config into the recorder to ensure that the DataSource related beans
-                    // are created after runtime configuration has been setup
+                    // are created after runtime configuration has been set up
                     .supplier(recorder.agroalDataSourceSupplier(dataSourceName, dataSourcesRuntimeConfig));
 
             if (entry.getValue().isDefault) {

extensions/amazon-lambda/common-deployment/src/main/java/io/quarkus/amazon/lambda/deployment/AmazonLambdaCommonProcessor.java

@@ -42,7 +42,7 @@ void tmpdirs(BuildProducer<SystemPropertyBuildItem> systemProperty,
             LaunchModeBuildItem launchModeBuildItem) {
         LaunchMode mode = launchModeBuildItem.getLaunchMode();
         if (mode.isDevOrTest()) {
-            return; // just in case we're on windows.
+            return; // just in case we're on Windows.
         }
         systemProperty.produce(new SystemPropertyBuildItem("java.io.tmpdir", "/tmp"));
         systemProperty.produce(new SystemPropertyBuildItem("vertx.cacheDirBase", "/tmp/vertx"));

extensions/amazon-lambda/common-runtime/src/main/java/io/quarkus/amazon/lambda/runtime/AbstractLambdaPollLoop.java

@@ -172,7 +172,7 @@ public void run() {
                     } catch (Exception ex) {
                         log.error("Failed to report init error (" + launchMode + ")", ex);
                     } finally {
-                        // our main loop is done, time to shutdown
+                        // our main loop is done, time to shut down
                         Application app = Application.currentApplication();
                         if (app != null) {
                             log.error("Shutting down Quarkus application because of error (" + launchMode + ")");
@@ -274,7 +274,7 @@ protected HttpURLConnection responseStream(URL url) throws IOException {
     }
 
     boolean abortGracefully(Exception ex) {
-        // if we are running in test mode, or native mode outside of the lambda container, then don't output stack trace for socket errors
+        // if we are running in test mode, or native mode outside the lambda container, then don't output stack trace for socket errors
 
         boolean lambdaEnv = System.getenv("AWS_LAMBDA_RUNTIME_API") != null;
         boolean testOrDevEnv = LaunchMode.current() == LaunchMode.TEST || LaunchMode.current() == LaunchMode.DEVELOPMENT;

extensions/amazon-lambda/common-runtime/src/main/java/io/quarkus/amazon/lambda/runtime/AmazonLambdaApi.java

@@ -32,7 +32,7 @@ public class AmazonLambdaApi {
     public static final String API_PATH_ERROR = "/error";
     public static final String API_PATH_RESPONSE = "/response";
 
-    // Only available in dev/test mode and points to path for mock even tserver
+    // Only available in dev/test mode and points to path for mock EventServer
     public static final String API_BASE_PATH_TEST = "/_lambda_";
     public static final String POST_EVENT = API_BASE_PATH_TEST;
 

extensions/arc/deployment/src/main/java/io/quarkus/arc/deployment/ReflectiveBeanClassBuildItem.java

@@ -7,7 +7,7 @@
 import io.quarkus.deployment.builditem.nativeimage.ReflectiveClassBuildItem;
 
 /**
- * This build item instructs ArC to produce a {@link ReflectiveClassBuildItem} for a client proxy and intercepred
+ * This build item instructs ArC to produce a {@link ReflectiveClassBuildItem} for a client proxy and intercepted
  * subclass generated for the given bean class.
  */
 public final class ReflectiveBeanClassBuildItem extends MultiBuildItem {

extensions/arc/deployment/src/main/java/io/quarkus/arc/deployment/staticmethods/InterceptedStaticMethodsProcessor.java

@@ -90,7 +90,7 @@ void collectInterceptedStaticMethods(BeanArchiveIndexBuildItem beanArchiveIndex,
             InterceptorResolverBuildItem interceptorResolver, TransformedAnnotationsBuildItem transformedAnnotations,
             BuildProducer<UnremovableBeanBuildItem> unremovableBeans) {
 
-        // In this step we collect all intercepted static methods, ie. static methods annotated with interceptor bindings
+        // In this step we collect all intercepted static methods, i.e. static methods annotated with interceptor bindings
         Set<DotName> interceptorBindings = interceptorResolver.getInterceptorBindings();
 
         for (ClassInfo clazz : beanArchiveIndex.getIndex().getKnownClasses()) {

extensions/arc/deployment/src/test/java/io/quarkus/arc/test/autoscope/AutoScopeBuildItemTest.java

@@ -33,7 +33,7 @@ public void execute(BuildContext context) {
                             return clazz.name().toString().equals(SimpleBean.class.getName());
                         }).defaultScope(BuiltinScope.DEPENDENT)
                                 .scopeAlreadyAdded((scope, reason) -> {
-                                    // We cant's pass the state directly to AutoScopeBuildItemTest because it's loaded by a different classloader
+                                    // We can't pass the state directly to AutoScopeBuildItemTest because it's loaded by a different classloader
                                     Logger.getLogger("AutoScopeBuildItemTest").info(scope + ":" + reason);
                                 }).build());
                     }

extensions/arc/runtime/src/main/java/io/quarkus/arc/config/ConfigProperties.java

@@ -55,7 +55,7 @@
     NamingStrategy namingStrategy() default NamingStrategy.FROM_CONFIG;
 
     /**
-     * Whether or not to fail when a non-public field of a class doesn't have a corresponding setter
+     * Whether to fail when a non-public field of a class doesn't have a corresponding setter
      */
     boolean failOnMismatchingMember() default DEFAULT_FAIL_ON_MISMATCHING_MEMBER;
 

extensions/arc/runtime/src/main/java/io/quarkus/arc/lookup/LookupIfProperty.java

@@ -11,7 +11,7 @@
 /**
  * Indicates that a bean should only be obtained by programmatic lookup if the property matches the provided value.
  * <p>
- * This annotation is repeatable. A bean will be included if all of the conditions defined by the {@link LookupIfProperty} and
+ * This annotation is repeatable. A bean will be included if all the conditions defined by the {@link LookupIfProperty} and
  * {@link LookupUnlessProperty} annotations are satisfied.
  *
  * <pre>

extensions/arc/runtime/src/main/java/io/quarkus/arc/lookup/LookupUnlessProperty.java

@@ -11,7 +11,7 @@
 /**
  * Indicates that a bean should only be obtained by programmatic lookup if the property does not match the provided value.
  * <p>
- * This annotation is repeatable. A bean will be included if all of the conditions defined by the {@link LookupUnlessProperty}
+ * This annotation is repeatable. A bean will be included if all the conditions defined by the {@link LookupUnlessProperty}
  * and {@link LookupIfProperty} annotations are satisfied.
  *
  * <pre>

extensions/arc/runtime/src/main/java/io/quarkus/arc/properties/IfBuildProperty.java

@@ -13,7 +13,7 @@
  * By default, the bean is not enabled when the build time property is not defined at all, but this behavior is configurable
  * via the {#code enableIfMissing} property.
  * <p>
- * This annotation is repeatable. A bean will only be enabled if all of the conditions defined by the {@link IfBuildProperty}
+ * This annotation is repeatable. A bean will only be enabled if all the conditions defined by the {@link IfBuildProperty}
  * annotations are satisfied.
  */
 @Repeatable(IfBuildProperty.List.class)

extensions/arc/runtime/src/main/java/io/quarkus/arc/properties/UnlessBuildProperty.java

@@ -13,7 +13,7 @@
  * By default, the bean is not enabled when the build time property is not defined at all, but this behavior is configurable
  * via the {#code enableIfMissing} property.
  * <p>
- * This annotation is repeatable. A bean will only be enabled if all of the conditions defined by the
+ * This annotation is repeatable. A bean will only be enabled if all the conditions defined by the
  * {@link UnlessBuildProperty} annotations are satisfied.
  */
 @Repeatable(UnlessBuildProperty.List.class)

extensions/container-image/spi/src/main/java/io/quarkus/container/spi/ContainerImageBuilderBuildItem.java

@@ -6,7 +6,7 @@
 /**
  * A {@link MultiBuildItem} that represents eligible container image builders.
  * Some extension have a dependency on external services (e.g. openshift and s2i).
- * So, the persennce of the extension alone is not enough to let the build system know that extension is usable.
+ * So, the presence of the extension alone is not enough to let the build system know that extension is usable.
  * This build item is produced only when all environment requirements are met.
  */
 public final class ContainerImageBuilderBuildItem extends MultiBuildItem {

extensions/datasource/deployment/src/main/java/io/quarkus/datasource/deployment/devservices/DevServicesDatasourceProcessor.java

@@ -86,7 +86,7 @@ DevServicesDatasourceResultBuildItem launchDatabases(CurateOutcomeBuildItem cura
                 for (RunningDevService database : databases) {
                     devServicesResultBuildItemBuildProducer.produce(database.toBuildItem());
                 }
-                // keep the previous behaviour of producing DevServicesDatasourceResultBuildItem only when the devservice first starts.
+                // keep the previous behaviour of producing DevServicesDatasourceResultBuildItem only when the devservices first starts.
                 return null;
             }
             for (Closeable i : databases) {

extensions/elasticsearch-rest-client/deployment/src/main/java/io/quarkus/elasticsearch/restclient/lowlevel/deployment/ElasticsearchBuildTimeConfig.java

@@ -7,7 +7,7 @@
 @ConfigRoot(name = "elasticsearch", phase = ConfigPhase.BUILD_TIME)
 public class ElasticsearchBuildTimeConfig {
     /**
-     * Whether or not an health check is published in case the smallrye-health extension is present.
+     * Whether a health check is published in case the smallrye-health extension is present.
      */
     @ConfigItem(name = "health.enabled", defaultValue = "true")
     public boolean healthEnabled;

extensions/elytron-security-common/deployment/src/main/java/io/quarkus/elytron/security/common/deployment/QuarkusSecurityCommonProcessor.java

@@ -23,7 +23,7 @@ public void registerPasswordProvider(ElytronCommonRecorder recorder) {
     }
 
     /**
-     * Graal VM now seems to loose providers registered at static init
+     * Graal VM now seems to lose providers registered at static init
      *
      * We re-register at runtime (which is a no-op in JVM mode)
      */

extensions/elytron-security-common/runtime/src/main/java/io/quarkus/elytron/security/common/BcryptUtil.java

@@ -97,7 +97,7 @@ public static String bcryptHash(String password, int iterationCount, byte[] salt
      *
      * @param plainText the plain text string to check
      * @param passwordHash the Modular Crypt Format bcrypt hash to compare against
-     * @return the boolean result of whether or not the plain text matches the decoded Modular Crypt Format bcrypt hash
+     * @return the boolean result of whether the plain text matches the decoded Modular Crypt Format bcrypt hash
      * @throws NullPointerException if the plainText password or passwordHash is null
      */
     public static boolean matches(String plainText, String passwordHash) {

extensions/elytron-security-common/runtime/src/main/java/io/quarkus/elytron/security/common/runtime/ElytronCommonRecorder.java

@@ -14,7 +14,7 @@ public class ElytronCommonRecorder {
 
     public void registerPasswordProvider() {
         //we don't remove this, as there is no correct place where it can be removed
-        //as continuous testing can be running along side the dev mode app, but there is
+        //as continuous testing can be running alongside the dev mode app, but there is
         //only ever one provider
         WildFlyElytronPasswordProvider provider = new WildFlyElytronPasswordProvider();
         if (Security.getProvider(provider.getName()) == null) {

extensions/elytron-security-ldap/deployment/src/main/java/io/quarkus/elytron/security/ldap/deployment/config/LdapSecurityRealmBuildTimeConfig.java

@@ -5,7 +5,7 @@
 import io.quarkus.runtime.annotations.ConfigRoot;
 
 /**
- * A configuration object for a LDAP based realm configuration,
+ * A configuration object for an LDAP based realm configuration,
  * {@linkplain org.wildfly.security.auth.realm.ldap.LdapSecurityRealm}
  */
 @ConfigRoot(name = "security.ldap", phase = ConfigPhase.BUILD_TIME)

extensions/elytron-security-ldap/runtime/src/main/java/io/quarkus/elytron/security/ldap/config/LdapSecurityRealmRuntimeConfig.java

@@ -5,7 +5,7 @@
 import io.quarkus.runtime.annotations.ConfigRoot;
 
 /**
- * Runtime configuration object for a LDAP based realm configuration,
+ * Runtime configuration object for an LDAP based realm configuration,
  * {@linkplain org.wildfly.security.auth.realm.ldap.LdapSecurityRealm}
  */
 @ConfigRoot(name = "security.ldap", phase = ConfigPhase.RUN_TIME)

extensions/elytron-security/deployment/src/main/java/io/quarkus/elytron/security/deployment/SecurityDomainBuildItem.java

@@ -6,7 +6,7 @@
 import io.quarkus.runtime.RuntimeValue;
 
 /**
- * This represent a {@linkplain SecurityDomain} instance output by a build step.
+ * This represents a {@linkplain SecurityDomain} instance output by a build step.
  */
 public final class SecurityDomainBuildItem extends SimpleBuildItem {
 

extensions/elytron-security/runtime/src/main/java/io/quarkus/elytron/security/runtime/ElytronRecorder.java

@@ -77,7 +77,7 @@ public boolean implies(Permission permission) {
     }
 
     /**
-     * Called to add an additional realm to the {@linkplain SecurityDomain} being built
+     * Called to add a realm to the {@linkplain SecurityDomain} being built
      *
      * @param builder - runtime value for SecurityDomain.Builder created by
      *        {@linkplain #configureDomainBuilder(String, RuntimeValue)}

extensions/flyway/deployment/src/main/java/io/quarkus/flyway/FlywayProcessor.java

@@ -162,7 +162,7 @@ ServiceStartBuildItem createBeansAndStartActions(FlywayRecorder recorder,
         // make a FlywayContainerProducer bean
         additionalBeans.produce(AdditionalBeanBuildItem.builder().addBeanClasses(FlywayContainerProducer.class).setUnremovable()
                 .setDefaultScope(DotNames.SINGLETON).build());
-        // add the @FlywayDataSource class otherwise it won't registered as a qualifier
+        // add the @FlywayDataSource class otherwise it won't be registered as a qualifier
         additionalBeans.produce(AdditionalBeanBuildItem.builder().addBeanClass(FlywayDataSource.class).build());
 
         recorder.resetFlywayContainers();

extensions/flyway/deployment/src/test/java/io/quarkus/flyway/test/FlywayDevModeTest.java

@@ -12,7 +12,7 @@
 /**
  * Flyway needs a datasource to work.
  * This tests assures, that an error occurs,
- * as soon as the default flyway configuration points to an missing default datasource.
+ * as soon as the default flyway configuration points to a missing default datasource.
  */
 public class FlywayDevModeTest {
 

extensions/flyway/deployment/src/test/java/io/quarkus/flyway/test/FlywayExtensionConfigEmptyTest.java

@@ -16,7 +16,7 @@
 /**
  * Flyway needs a datasource to work.
  * This tests assures, that an error occurs,
- * as soon as the default flyway configuration points to an missing default datasource.
+ * as soon as the default flyway configuration points to a missing default datasource.
  */
 public class FlywayExtensionConfigEmptyTest {
 

extensions/flyway/deployment/src/test/java/io/quarkus/flyway/test/FlywayExtensionConfigMissingNamedDataSourceTest.java

@@ -16,7 +16,7 @@
 
 /**
  * Flyway needs a datasource to work.
- * This tests assures, that an error occurs, as soon as a named flyway configuration points to an missing datasource.
+ * This tests assures that an error occurs as soon as a named flyway configuration points to a missing datasource.
  */
 public class FlywayExtensionConfigMissingNamedDataSourceTest {
 

extensions/flyway/runtime/src/main/java/io/quarkus/flyway/runtime/FlywayContainerProducer.java

@@ -14,7 +14,7 @@
  * and it's {@code createFlyway} method is called at runtime in order to produce
  * the actual {@code Flyway} objects.
  *
- * CDI scopes and qualifiers are setup at build-time, which is why this class is devoid of
+ * CDI scopes and qualifiers are set up at build-time, which is why this class is devoid of
  * any CDI annotations
  *
  */

extensions/flyway/runtime/src/main/java/io/quarkus/flyway/runtime/FlywayDataSourceBuildTimeConfig.java

@@ -30,7 +30,7 @@ public final class FlywayDataSourceBuildTimeConfig {
     /**
      * Comma-separated list of fully qualified class names of Callback implementations
      * to use to hook into the Flyway lifecycle.
-     * The {@link org.flywaydb.core.api.callback.Callback} sub-class must have a no-args constructor and must not be abstract.
+     * The {@link org.flywaydb.core.api.callback.Callback} subclass must have a no-args constructor and must not be abstract.
      * These classes must also not have any fields that hold state (unless that state is initialized in the constructor).
      */
     @ConfigItem

extensions/flyway/runtime/src/main/java/io/quarkus/flyway/runtime/FlywayDataSourceRuntimeConfig.java

@@ -53,7 +53,7 @@ public static final FlywayDataSourceRuntimeConfig defaultConfig() {
 
     /**
      * The name of Flyway's schema history table.
-     * By default (single-schema mode) the schema history table is placed in the default schema for the connection provided by
+     * By default (single-schema mode), the schema history table is placed in the default schema for the connection provided by
      * the datasource.
      * When the flyway.schemas property is set (multi-schema mode), the schema history table is placed in the first schema of
      * the list.

extensions/funqy/funqy-google-cloud-functions/deployment/src/main/java/io/quarkus/funqy/gcp/functions/deployment/bindings/CloudFunctionsDeploymentBuildStep.java

@@ -24,7 +24,7 @@ public UberJarRequiredBuildItem forceUberJar() {
 
     /**
      * Creates a target/deployment dir and copy the uber jar in it.
-     * This facilitates the usage of the 'glcoud' command.
+     * This facilitates the usage of the 'gcloud' command.
      */
     @BuildStep(onlyIf = IsNormal.class, onlyIfNot = NativeBuild.class)
     public ArtifactResultBuildItem functionDeployment(OutputTargetBuildItem target, JarBuildItem jar)

extensions/funqy/funqy-google-cloud-functions/runtime/src/main/java/io/quarkus/funqy/gcp/functions/event/PubsubMessage.java

@@ -3,7 +3,7 @@
 import java.util.Map;
 
 /**
- * Background function event for Pubsub
+ * Background function event for Pub/Sub.
  *
  * @see <a href="https://cloud.google.com/pubsub/docs/reference/rest/v1/PubsubMessage">PubsubMessage</a>
  */

extensions/google-cloud-functions-http/deployment/src/main/java/io/quarkus/gcp/functions/http/deployment/CloudFunctionsDeploymentBuildStep.java

@@ -23,7 +23,7 @@ public UberJarRequiredBuildItem forceUberJar() {
 
     /**
      * Creates a target/deployment dir and copy the uber jar in it.
-     * This facilitates the usage of the 'glcoud' command.
+     * This facilitates the usage of the 'gcloud' command.
      */
     @BuildStep(onlyIf = IsNormal.class, onlyIfNot = NativeBuild.class)
     public ArtifactResultBuildItem functionDeployment(OutputTargetBuildItem target, JarBuildItem jar)

extensions/google-cloud-functions/deployment/src/main/java/io/quarkus/gcp/functions/deployment/CloudFunctionDeploymentBuildStep.java

@@ -31,7 +31,7 @@ void failForNativeSources(BuildProducer<ArtifactResultBuildItem> artifactResultP
 
     /**
      * Creates a target/deployment dir and copy the uber jar in it.
-     * This facilitates the usage of the 'glcoud' command.
+     * This facilitates the usage of the 'gcloud' command.
      */
     @BuildStep(onlyIf = IsNormal.class, onlyIfNot = NativeBuild.class)
     public ArtifactResultBuildItem functionDeployment(OutputTargetBuildItem target, JarBuildItem jar)

extensions/grpc/runtime/src/main/java/io/quarkus/grpc/runtime/config/GrpcClientConfiguration.java

@@ -63,7 +63,7 @@ public class GrpcClientConfiguration {
     public Optional<Duration> idleTimeout;
 
     /**
-     * The amount of time the sender of of a keep alive ping waits for an acknowledgement.
+     * The amount of time the sender of a keep alive ping waits for an acknowledgement.
      */
     @ConfigItem
     public Optional<Duration> keepAliveTimeout;
@@ -147,8 +147,8 @@ public class GrpcClientConfiguration {
 
     /**
      * Use a custom load balancing policy.
-     * Accepted values are: {@code pick_value}, {@code round_robin}, {@code grpclb}
-     * This value is ignored if name-resolver is set to 'stork'
+     * Accepted values are: {@code pick_value}, {@code round_robin}, {@code grpclb}.
+     * This value is ignored if name-resolver is set to 'stork'.
      */
     @ConfigItem(defaultValue = "pick_first")
     public String loadBalancingPolicy;

extensions/grpc/runtime/src/main/java/io/quarkus/grpc/runtime/config/GrpcCodeGenConfig.java

@@ -33,7 +33,7 @@ public class GrpcCodeGenConfig {
      * <li><i>all</i> - scan all dependencies</li>
      * </ul>
      *
-     * By default: <i>com.google.protobuf:protobuf-java</i>
+     * By default, <i>com.google.protobuf:protobuf-java</i>.
      */
     @ConfigItem(defaultValue = "com.google.protobuf:protobuf-java")
     public String scanForImports;

extensions/grpc/runtime/src/main/java/io/quarkus/grpc/runtime/config/GrpcServerBuildTimeConfig.java

@@ -7,13 +7,13 @@
 @ConfigRoot(phase = ConfigPhase.BUILD_TIME, name = "grpc.server")
 public class GrpcServerBuildTimeConfig {
     /**
-     * Whether or not a health check on gRPC status is published in case the smallrye-health extension is present.
+     * Whether a health check on gRPC status is published in case the smallrye-health extension is present.
      */
     @ConfigItem(name = "health.enabled", defaultValue = "true")
     public boolean mpHealthEnabled;
 
     /**
-     * Whether or not the gRPC health check is exposed.
+     * Whether the gRPC health check is exposed.
      */
     @ConfigItem(name = "grpc-health.enabled", defaultValue = "true")
     public boolean grpcHealthEnabled;

extensions/hibernate-orm/deployment/src/main/java/io/quarkus/hibernate/orm/deployment/HibernateEntityEnhancer.java

@@ -72,7 +72,7 @@ public ClassLoader getLoadingClassLoader() {
         @Override
         public void visitEnd() {
             super.visitEnd();
-            final ClassWriter writer = (ClassWriter) this.cv; //safe cast: cv is the the ClassWriter instance we passed to the super constructor
+            final ClassWriter writer = (ClassWriter) this.cv; //safe cast: cv is the ClassWriter instance we passed to the super constructor
             //We need to convert the nice Visitor chain into a plain byte array to adapt to the Hibernate ORM
             //enhancement API:
             final byte[] inputBytes = writer.toByteArray();

extensions/hibernate-orm/deployment/src/main/java/io/quarkus/hibernate/orm/deployment/HibernateOrmConfig.java

@@ -52,7 +52,7 @@ public class HibernateOrmConfig {
     public Optional<Boolean> logSessionMetrics;
 
     /**
-     * Whether or not metrics are published if a metrics extension is enabled.
+     * Whether metrics are published if a metrics extension is enabled.
      */
     @ConfigItem(name = "metrics.enabled")
     public boolean metricsEnabled;

extensions/hibernate-orm/deployment/src/test/java/io/quarkus/hibernate/orm/devconsole/MyEntityWithFailingDDLGeneration.java

@@ -20,7 +20,7 @@ public class MyEntityWithFailingDDLGeneration {
     @GeneratedValue(strategy = GenerationType.SEQUENCE, generator = "myEntitySeq")
     public Long id;
 
-    // The goal of this cusstom type is to trigger an error during DDL generation
+    // The goal of this custom type is to trigger an error during DDL generation
     @Type(type = "typeWithUnsupportedSqlCode")
     public String name;