Merge pull request #958 from galasa-dev/ash-1249-signed

Suppressed / Fixed excessive comments made by javadoc

galasa-managers-parent/build.gradle

@@ -22,6 +22,26 @@ subprojects {
    plugins.withId('jacoco')  {
         rootProject.tasks.named('jacocoMerge').get().executionData(tasks.named('test').get())
    }
+
+    // Uncomment the block below to get details about deprecations.
+
+//    tasks.withType(JavaCompile) {
+//         options.compilerArgs << '-Xlint:unchecked'
+//         options.deprecation = true
+//     }
+
+    // This task will suppress warnings (only in javadoc) about missing description for (@return, @throws etc..)
+    /*
+        Example warning:
+        
+        warning: no description for @throws
+         * @throws SeleniumManagerException
+    */
+    // However, it will not suppress warnings / errors in the code itself
+    tasks.withType(Javadoc) {
+        options.addStringOption('Xdoclint:none', '-quiet')
+    }
+
 }
 
 // Define the artifact

galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/ICeci.java

@@ -75,8 +75,8 @@ public interface ICeci {
      * @param parseOutput parse the command output and store in {@link ICeciResponse}. Setting to false can improve performance on commands
      * that contain a lot of output fields, e.g. <code>ASSIGN</code>.<br><br>
      * The following examples shows how to retrieve a specific returned value:<br><code>
-     * issueCommand(ICicsTerminal, "ASSIGN USERID(&VAR)", false)<br>
-     * retrieveVariableText(ICicsTerminal, "ASSIGN USERID(&VAR)", false)
+     * issueCommand(ICicsTerminal, "ASSIGN USERID(&amp;VAR)", false)<br>
+     * retrieveVariableText(ICicsTerminal, "ASSIGN USERID(&amp;VAR)", false)
      * </code>
      * @return an {@link ICeciResponse} object containing the command's response.
      * @throws CeciException 
@@ -239,7 +239,7 @@ public interface ICeci {
 
     /**
      * Retrieve the content of the current EXEC Interface Block (EIB)
-     * @param terminal an {@link ICicsTerminal} object logged on to the CICS region and in an active CECI session.
+     * @param ceciTerminal an {@link ICicsTerminal} object logged on to the CICS region and in an active CECI session.
      * @return the {@link IExecInterfaceBlock} 
      * @throws CeciException
      */
@@ -252,7 +252,7 @@ public interface ICeci {
      * For example, the test could first issue <code>CEOT TRANIDONLY</code>
      * @param programName the name of the PROGRAM
      * @param commarea a string representing the COMMAREA. If null, COMMAREA will be omitted from the command. Can be CECI variable name populated with
-     *  (<b>&</b>name set via {@link #defineVariableText(ICicsTerminal, String, String)}) or the actual data. The value of DATALENGTH in the command will be 
+     *  (<b>&amp;</b>)name set via {@link #defineVariableText(ICicsTerminal, String, String)}) or the actual data. The value of DATALENGTH in the command will be 
      * be allowed to default.
      * @param sysid the system name where the CICS region where the link request is to be routed. If null, SYSID will be omitted from the command.
      * @param transid the name of the mirror transaction on the remote region. If null, TRANSID will be omitted from the command.
@@ -263,8 +263,8 @@ public interface ICeci {
     public ICeciResponse linkProgram(@NotNull ICicsTerminal ceciTerminal, @NotNull String programName, String commarea, String sysid, String transid, boolean synconreturn) throws CeciException;
 
     /**
-     * EXEC CICS LINK to a PROGRAM with a CHANNEL. Use {@link #putContainer(ICicsTerminal, String, String, String)} to create the container(s) on the CHANNEL 
-     * and {@link #getContainer(ICicsTerminal, String, String, String)} to retrieve the content after the LINK.
+     * EXEC CICS LINK to a PROGRAM with a CHANNEL. Use {@link #putContainer(ICicsTerminal, String, String, String, String, String, String)} to create the container(s) on the CHANNEL 
+     * and {@link #getContainer(ICicsTerminal, String, String, String, String, String)} to retrieve the content after the LINK.
      * @param ceciTerminal an {@link ICicsTerminal} object logged on to the CICS region and in an active CECI session.
      * If mixed case is required, the terminal should be presented with no upper case translate status. 
      * For example, the test could first issue <code>CEOT TRANIDONLY</code>  
@@ -279,7 +279,7 @@ public interface ICeci {
      * @param ceciTerminal an {@link ICicsTerminal} object logged on to the CICS region and in an active CECI session.
      * @param channelName the CHANNELNAME
      * @param containerName the COTAINER name
-     * @param content a string representing the container contents. Can be CECI variable name populated with (<b>&</b>name set via {@link #defineVariableText(ICicsTerminal, String, String)}) 
+     * @param content a string representing the container contents. Can be CECI variable name populated with (<b>&amp;</b>)name set via {@link #defineVariableText(ICicsTerminal, String, String)}) 
      * or the actual data. The value of FLENGTH in the command will be set to the data length.
      * @param dataType BIT or CHAR. If null, DATATYPE will be omitted from the command.
      * @param fromCcsid provides a value for FROMCCSID. If null, will be omitted from the command.
@@ -296,8 +296,7 @@ public interface ICeci {
      * For example, the test could first issue <code>CEOT TRANIDONLY</code>
      * @param channelName the CHANNELNAME
      * @param containerName the CONTAINER name
-     * @param variableName the CECI variable name. Data can be retrieved using {@link #retrieveVariableText(ICicsTerminal, String)} or {@link #retrieveVariableHex(ICicsTerminal, String)}
-     * @param dataType BIT or CHAR. If null, DATATYPE will be omitted from the command. 
+     * @param variableName the CECI variable name. Data can be retrieved using {@link #retrieveVariableText(ICicsTerminal, String)}
      * @param intoCcsid provides a value for INTOCCSID. If null, will be omitted from the command.
      * @param intoCodepage provides a value for INTOCODEPAGE. If null, will be omitted from the command.
      * @return an {@link ICeciResponse} object containing the command's response.

galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/ICemt.java

@@ -16,7 +16,7 @@ public interface ICemt {
     /** 
      * Inquire a CEMT resource using the resource type and name.
      * This does not support inquiries of multiple resources at once. 
-     * Will return {@link null} if the resource is not found.
+     * @return null if the resource is not found.
      * @param cemtTerminal an {@link ITerminal} object logged on to the CICS region and in an active CEMT session.
      * If mixed case is required, the terminal should be presented with no upper case translate status. 
      * For example, the test could first issue <code>CEOT TRANIDONLY</code>

galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/IExecInterfaceBlock.java

@@ -1,8 +1,8 @@
-/*
- * Copyright contributors to the Galasa project
- *
- * SPDX-License-Identifier: EPL-2.0
- */
+/*
+ * Copyright contributors to the Galasa project
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
 package dev.galasa.cicsts;
 
 /**
@@ -12,188 +12,186 @@
 public interface IExecInterfaceBlock {
 
     /**
-     * Returns a {@link String} representation of the EIBRESP field if available
-     * @return
+     * @return a {@link String} representation of the EIBRESP field if available
      */
     public String getResponse();
 
     /**
-     * Returns the value of the EIBTIME field in the EIB.
-     * @return
+     * @return the value of the EIBTIME field in the EIB.
+     *
      */
     public int getEIBTIME();
 
     /**
-     * Returns the value of the EIBDATE field in the EIB.
-     * @return
+     * @return the value of the EIBDATE field in the EIB.
+     * 
      */
     public int getEIBDATE();
 
     /**
-     * Returns the value of the EIBTRNID field in the EIB.
+     * @return the value of the EIBTRNID field in the EIB.
      * @param hex return a char array containing the hex values of the field
-     * @return
+     * 
      */
     public String getEIBTRNID(boolean hex);
 
     /**
-     * Returns the value of the EIBTASKN field in the EIB.
-     * @return
+     * @return the value of the EIBTASKN field in the EIB.
+     * 
      */
     public int getEIBTASKN();
 
     /**
-     * Returns the value of the EIBTRMID field in the EIB.
+     * @return the value of the EIBTRMID field in the EIB.
      * @param hex return a char array containing the hex values of the field
-     * @return
+     * 
      */
     public String getEIBTRMID(boolean hex);
 
     /**
-     * Returns the value of the EIBCPOSN field in the EIB.
-     * @param hex return a char array containing the hex values of the field
-     * @return
+     * @return the value of the EIBCPOSN field in the EIB.
+     * 
      */
     public int getEIBCPOSN();
 
     /**
-     * Returns the value of the EIBCALEN field in the EIB.
-     * @return
+     * @return the value of the EIBCALEN field in the EIB.
+     * 
      */
     public int getEIBCALEN();
 
     /**
-     * Returns the value of the EIBAID field in the EIB.
-     * @return
+     * @return the value of the EIBAID field in the EIB.
+     * 
      */
     public char getEIBAID();
 
     /**
-     * Returns the value of the EIBFN field in the EIB.
-     * @return
+     * @return the value of the EIBFN field in the EIB.
+     * 
      */
     public char[] getEIBFN();
 
     /**
-     * Returns the value of the EIBRCODE  field in the EIB.
-     * @return
+     * @return the value of the EIBRCODE  field in the EIB.
+     * 
      */
     public char[] getEIBRCODE();
 
     /**
-     * Returns the value of the EIBDS  field in the EIB.
+     * @return the value of the EIBDS  field in the EIB.
      * @param hex return a char array containing the hex values of the field
-     * @return
+     * 
      */
     public String getEIBDS(boolean hex);
 
     /**
-     * Returns the value of the EIBREQID field in the EIB.
+     * @return the value of the EIBREQID field in the EIB.
      * @param hex return a char array containing the hex values of the field
-     * @return
+     * 
      */
     public String getEIBREQID(boolean hex);
 
     /**
-     * Returns the value of the EIBRSRCE field in the EIB.
+     * @return the value of the EIBRSRCE field in the EIB.
      * @param hex return a char array containing the hex values of the field
-     * @return
+     * 
      */
     public String getEIBRSRCE(boolean hex);
 
     /**
-     * Returns the value of the EIBSYNC field in the EIB.
-     * @return
+     * @return the value of the EIBSYNC field in the EIB.
+     * 
      */
     public char getEIBSYNC();
 
     /**
-     * Returns the value of the EIBFREE field in the EIB.
-     * @return
+     * @return the value of the EIBFREE field in the EIB.
+     * 
      */
     public char getEIBFREE();
 
     /**
-     * Returns the value of the EIBRECV field in the EIB.
-     * @return
+     * @return the value of the EIBRECV field in the EIB.
+     * 
      */
     public char getEIBRECV();
 
     /**
-     * Returns the value of the EIBATT field in the EIB.
-     * @return
+     * @return the value of the EIBATT field in the EIB.
+     * 
      */
     public char getEIBATT();
 
     /**
-     * Returns the value of the EIBEOC field in the EIB.
-     * @return
+     * @return the value of the EIBEOC field in the EIB.
+     * 
      */
     public char getEIBEOC();
 
     /**
-     * Returns the value of the  field in the EIB.
-     * @return
+     * @return the value of the  field in the EIB.
+     * 
      */
     public char getEIBFMH();
 
     /**
-     * Returns the value of the EIBCOMPL field in the EIB.
-     * @return
+     * @return the value of the EIBCOMPL field in the EIB.
+     * 
      */
     public char getEIBCOMPL();
 
     /**
-     * Returns the value of the EIBSIG field in the EIB.
-     * @return
+     * @return the value of the EIBSIG field in the EIB.
+     * 
      */
     public char getEIBSIG();
 
     /**
-     * Returns the value of the EIBCONF field in the EIB.
-     * @return
+     * @return the value of the EIBCONF field in the EIB.
+     * 
      */
     public char getEIBCONF();
 
     /**
-     * Returns the value of the EIBERR field in the EIB.
-     * @return
+     * @return the value of the EIBERR field in the EIB.
+     * 
      */
     public char getEIBERR();
 
     /**
-     * Returns the value of the EIBERRCD field in the EIB.
-     * @return
+     * @return the value of the EIBERRCD field in the EIB.
+     * 
      */
     public char[] getEIBERRCD();
 
     /**
-     * Returns the value of the EIBSYNRB field in the EIB.
-     * @return
+     * @return the value of the EIBSYNRB field in the EIB.
+     * 
      */
     public char getEIBSYNRB();
 
     /**
-     * Returns the value of the EIBNODAT field in the EIB.
-     * @return
+     * @return the value of the EIBNODAT field in the EIB.
+     * 
      */
     public char getEIBNODAT();
 
     /**
-     * Returns the value of the EIBRESP field in the EIB.
-     * @return
+     * @return the value of the EIBRESP field in the EIB.
+     * 
      */
     public int getEIBRESP();
 
     /**
-     * Returns the value of the EIBRESP2 field in the EIB.
-     * @return
+     * @return the value of the EIBRESP2 field in the EIB.
+     * 
      */
     public int getEIBRESP2();
 
     /**
-     * Returns the value of the EIBRLDBK field in the EIB.
-     * @return
+     * @return the value of the EIBRLDBK field in the EIB.
+     * 
      */
     public char getEIBRLDBK();
 }

galasa-managers-parent/galasa-managers-cicsts-parent/dev.galasa.cicsts.manager/src/main/java/dev/galasa/cicsts/cicsresource/IJvmserver.java

@@ -1,8 +1,8 @@
-/*
- * Copyright contributors to the Galasa project
- *
- * SPDX-License-Identifier: EPL-2.0
- */
+/*
+ * Copyright contributors to the Galasa project
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
 package dev.galasa.cicsts.cicsresource;
 
 import java.util.List;
@@ -394,7 +394,6 @@ public enum PurgeType {
 
 	/**
 	 * Delete the JVM server logs
-     * @param rasPath path in Results Archive Store
      * @throws CicsJvmserverResourceException
 	 */
 	public void clearJvmLogs() throws CicsJvmserverResourceException;

galasa-managers-parent/galasa-managers-cloud-parent/dev.galasa.cloud.manager/src/main/java/dev/galasa/cloud/internal/CloudManagerImpl.java

@@ -168,7 +168,7 @@ public void provisionGenerate() throws ManagerException, ResourceUnavailableExce
 	 * 
 	 * @param field The test field
 	 * @param annotations any annotations with the ecosystem
-	 * @return a {@link IKubernetesEcosystem} ecosystem
+	 * @return a {@link dev.galasa.galasaecosystem.IKubernetesEcosystem} ecosystem
 	 * @throws InsufficientResourcesAvailableException 
 	 * @throws KubernetesManagerException if there is a problem generating a ecosystem
 	 */