Fix 2.0 rc1 javadoc (#679)

* Fix javadoc issues in operator-model

* Fix javadoc issues in operator-runtime

* Fix javadoc warnings in json-schema-maven-plugin

Author: markxnelson

json-schema-maven-plugin/src/main/java/oracle/kubernetes/json/mojo/Main.java

@@ -56,6 +56,7 @@ public interface Main {
   /**
    * Returns a resource from the classpath, corresponding to the specified name.
    *
+   * @param name Name of the resource to be returned
    * @return a url to the specified resource, or null if none is found
    */
   URL getResource(String name);
@@ -65,6 +66,7 @@ public interface Main {
    *
    * @param className the root class for the schema
    * @param outputFile the file to generate
+   * @throws MojoExecutionException If an exception occurred during the schema generation
    */
   void generateSchema(String className, File outputFile) throws MojoExecutionException;
 }

model/src/main/java/oracle/kubernetes/weblogic/domain/ClusterConfigurator.java

@@ -76,7 +76,7 @@ ClusterConfigurator withLivenessProbeSettings(
    * Add security constraints at container level, if the same constraint is also defined at pod
    * level then container constraint take precedence
    *
-   * @param podSecurityContext
+   * @param podSecurityContext pod-level security attributes to be added to this ClusterConfigurator
    * @return this object
    */
   ClusterConfigurator withPodSecurityContext(V1PodSecurityContext podSecurityContext);

model/src/main/java/oracle/kubernetes/weblogic/domain/DomainConfigurator.java

@@ -45,15 +45,17 @@ public DomainConfigurator withDomainHome(String domainHome) {
   }
 
   /**
-   * @param domainHomeInImage
-   * @return
+   * Specifies whether the domain home is stored in the image
+   *
+   * @param domainHomeInImage boolean indicating if the domain home is stored in the image
+   * @return this object
    */
   public DomainConfigurator withDomainHomeInImage(boolean domainHomeInImage) {
     getDomainSpec().setDomainHomeInImage(domainHomeInImage);
     return this;
   }
 
-  /** Defines a name for the domain's admin server. */
+  /** @return An AdminServerConfigurator object for configuring an admin server */
   public abstract AdminServerConfigurator configureAdminServer();
 
   public void withDefaultReplicaCount(int replicas) {
@@ -169,6 +171,7 @@ public abstract void withDefaultLivenessProbeSettings(
    * Sets the default server start policy ("ALWAYS", "NEVER" or "IF_NEEDED") for the domain.
    *
    * @param startPolicy the new default policy
+   * @return this object
    */
   public abstract DomainConfigurator withDefaultServerStartPolicy(String startPolicy);
 
@@ -260,7 +263,7 @@ public abstract DomainConfigurator withContainerSecurityContext(
    * Add security constraints at container level, if the same constraint is also defined at pod
    * level then container constraint take precedence
    *
-   * @param podSecurityContext
+   * @param podSecurityContext pod-level security attributes to be added to this DomainConfigurator
    * @return this object
    */
   public abstract DomainConfigurator withPodSecurityContext(

model/src/main/java/oracle/kubernetes/weblogic/domain/ServerConfigurator.java

@@ -72,7 +72,7 @@ ServerConfigurator withReadinessProbeSettings(
    * Add security constraints at container level, if the same constraint is also defined at pod
    * level then container constraint take precedence
    *
-   * @param podSecurityContext
+   * @param podSecurityContext pod-level security attributes to be added to this ServerConfigurator
    * @return this object
    */
   ServerConfigurator withPodSecurityContext(V1PodSecurityContext podSecurityContext);

model/src/main/java/oracle/kubernetes/weblogic/domain/v2/DomainSpec.java

@@ -170,8 +170,8 @@ public class DomainSpec extends BaseConfiguration {
   /**
    * Adds a Cluster to the DomainSpec
    *
-   * @param cluster
-   * @return
+   * @param cluster The cluster to be added to this DomainSpec
+   * @return this object
    */
   public DomainSpec withCluster(Cluster cluster) {
     clusters.add(cluster);

model/src/main/java/oracle/kubernetes/weblogic/domain/v2/ManagedServerSpecV2Impl.java

@@ -10,9 +10,9 @@ public class ManagedServerSpecV2Impl extends ServerSpecV2Impl {
    *
    * @param spec the domain specification
    * @param server the server whose configuration is to be returned
+   * @param cluster the cluster that this managed server belongs to
    * @param clusterLimit the number of servers desired for the cluster, or null if not a clustered
    *     server
-   * @param configurations the additional configurations to search for values if the server lacks
    */
   public ManagedServerSpecV2Impl(
       DomainSpec spec, Server server, Cluster cluster, Integer clusterLimit) {

operator/src/main/java/oracle/kubernetes/operator/PodWatcher.java

@@ -49,6 +49,7 @@ public class PodWatcher extends Watcher<V1Pod>
    * @param factory thread factory
    * @param ns Namespace
    * @param initialResourceVersion Initial resource version or empty string
+   * @param tuning Watch tuning parameters
    * @param listener Callback for watch events
    * @param isStopping Stop signal
    * @return Pod watcher for the namespace

operator/src/main/java/oracle/kubernetes/operator/helpers/CRDHelper.java

@@ -35,6 +35,7 @@ private CRDHelper() {}
   /**
    * Factory for {@link Step} that creates Domain CRD
    *
+   * @param version Version of the Kubernetes API Server
    * @param next Next step
    * @return Step for creating Domain custom resource definition
    */

operator/src/main/java/oracle/kubernetes/operator/helpers/CallBuilder.java

@@ -520,6 +520,7 @@ private com.squareup.okhttp.Call deleteConfigMapAsync(
    *
    * @param name Name
    * @param namespace Namespace
+   * @param deleteOptions Delete options
    * @param responseStep Response step for when call completes
    * @return Asynchronous step
    */
@@ -823,6 +824,7 @@ private com.squareup.okhttp.Call deleteJobAsync(
    *
    * @param name Name
    * @param namespace Namespace
+   * @param deleteOptions Delete options
    * @param responseStep Response step for when call completes
    * @return Asynchronous step
    */

operator/src/main/java/oracle/kubernetes/operator/helpers/ConfigMapHelper.java

@@ -249,6 +249,7 @@ public boolean containsAll(V1ConfigMap actual, V1ConfigMap expected) {
   /**
    * Factory for {@link Step} that creates config map containing sit config
    *
+   * @param next Next step
    * @return Step for creating config map containing sit config
    */
   public static Step createSitConfigMapStep(Step next) {
@@ -425,6 +426,8 @@ Map<String, String> getCombinedData(V1ConfigMap existingConfigMap) {
   /**
    * Factory for {@link Step} that deletes introspector config map
    *
+   * @param domainUID The unique identifier assigned to the Weblogic domain when it was registered
+   * @param namespace Namespace
    * @param next Next processing step
    * @return Step for deleting introspector config map
    */