Fixes piranhacloud#3521 - Fix JavaDoc issues for piranha-arquillian-s…

…erver module
mnriem · Sep 2, 2023 · d7395a3 · d7395a3
1 parent 1833342
commit d7395a3
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 6 deletions.
diff --git a/.../server/src/main/java/cloud/piranha/arquillian/server/PiranhaServerLoadableExtension.java b/.../server/src/main/java/cloud/piranha/arquillian/server/PiranhaServerLoadableExtension.java
@@ -56,9 +56,16 @@ public void register(ExtensionBuilder builder) {
         builder.service(DeployableContainer.class, PiranhaServerDeployableContainer.class);
     }
 
-    // Defines the configuration class used: PiranhaServerContainerConfiguration.class
-    // Defines the protocol used: "Servlet 5.0"
-
+    /**
+     * The Piranha DeployableContainer.
+     * 
+     * <pre>
+     *  Defines the configuration class used: PiranhaServerContainerConfiguration.class
+     *  Defines the protocol used: "Servlet 5.0"
+     * </pre>
+     * 
+     * @author Manfred Riem (mriem@manorrock.com)
+     */
     public abstract static class PiranhaServerContainerBase implements DeployableContainer<PiranhaServerContainerConfiguration> {
 
         @Override
@@ -72,8 +79,15 @@ public ProtocolDescription getDefaultProtocol() {
         }
     }
 
-    // Defines the configuration class to be essentially the same as MicroConfiguration.class
-
+    /**
+     * The Piranha MicroConfiguration.
+     * 
+     * <pre>
+     *  Defines the configuration class to be essentially the same as MicroConfiguration.class
+     * </pre>
+     * 
+     * @author Manfred Riem (mriem@manorrock.com)
+     */
     public static class PiranhaServerContainerConfiguration extends MicroConfiguration implements ContainerConfiguration {
 
         /**
@@ -117,7 +131,7 @@ public void validate() throws ConfigurationException {
          * Initializes configuration after all configured values were loaded.
          * Computes generated configuration, e.g. a free port for autoPort
          *
-         * @return
+         * @return the PiranhaServerContainerConfiguration.
          */
         @Override
         public PiranhaServerContainerConfiguration postConstruct() {

diff --git a/arquillian/server/src/main/java/module-info.java b/arquillian/server/src/main/java/module-info.java
@@ -30,6 +30,11 @@
 
 import cloud.piranha.arquillian.server.PiranhaServerLoadableExtension;
 
+/**
+ * The Piranha Arquillian Server module.
+ * 
+ * @author Manfred Riem (mriem@manorrock.com)
+ */
 module cloud.piranha.arquillian.server {
 
     provides LoadableExtension with PiranhaServerLoadableExtension;