Merge pull request #527 from TheSnoozer/fix-javadoc

fix javadoc generation for java 12 / 13

Author: TheSnoozer

core/pom.xml

@@ -21,6 +21,21 @@
         <junit.version>4.13.1</junit.version>
     </properties>
 
+    <build>
+        <plugins>
+            <!-- Setting built-in java compiler properties -->
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-compiler-plugin</artifactId>
+                <configuration>
+                    <source>${java.target}</source>
+                    <target>${java.target}</target>
+                    <compilerArgument>-Xlint:deprecation</compilerArgument>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build>
+
     <dependencies>
         <!-- JGit -->
         <dependency>

core/src/main/java/pl/project13/core/GitDataProvider.java

@@ -221,6 +221,7 @@ void validateAbbrevLength(int abbrevLength) throws GitCommitIdExecutionException
    *
    * @param env environment settings
    * @return results of getBranchName() or, if in Jenkins/Hudson, value of GIT_BRANCH
+   * @throws GitCommitIdExecutionException the branch name could not be determined
    */
   protected String determineBranchName(@Nonnull Map<String, String> env) throws GitCommitIdExecutionException {
     BuildServerDataProvider buildServerDataProvider = BuildServerDataProvider.getBuildServerProvider(env,log);

core/src/main/java/pl/project13/core/NativeGitProvider.java

@@ -371,10 +371,24 @@ private ProcessRunner getRunner() {
   }
 
   public interface ProcessRunner {
-    /** Run a command and return the entire output as a String - naive, we know. */
+    /** Run a command and return the entire output as a String - naive, we know.
+     *
+     * @param directory the directory where the command should be executed in
+     * @param nativeGitTimeoutInMs the timeout in milliseconds before the command get's terminated
+     * @param command the command to execute
+     * @return the output obtained from stdout by running the command
+     * @throws IOException the command execution failed
+     */
     String run(File directory, long nativeGitTimeoutInMs, String command) throws IOException;
 
-    /** Run a command and return false if it contains at least one output line*/
+    /** Run a command and return false if it contains at least one output line
+     *
+     * @param directory the directory where the command should be executed in
+     * @param nativeGitTimeoutInMs the timeout in milliseconds before the command get's terminated
+     * @param command the command to execute
+     * @return false if the output of the command contains at least one line on stdout, true otherwise
+     * @throws IOException the command execution failed
+     */
     boolean runEmpty(File directory, long nativeGitTimeoutInMs, String command) throws IOException;
   }
 

core/src/main/java/pl/project13/core/cibuild/AwsCodeBuildBuildServerData.java

@@ -31,6 +31,8 @@ public class AwsCodeBuildBuildServerData extends BuildServerDataProvider {
   }
 
   /**
+   * @param env The current system environment variables, obtained via System.getenv().
+   * @return true, if the system environment variables contain the AWS specific environment variable; false otherwise
    * @see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-env-vars.html">Environment variables in build environments</a>
    */
   public static boolean isActiveServer(Map<String, String> env) {

core/src/main/java/pl/project13/core/cibuild/AzureDevOpsBuildServerData.java

@@ -31,6 +31,8 @@ public class AzureDevOpsBuildServerData extends BuildServerDataProvider {
   }
 
   /**
+   * @param env The current system environment variables, obtained via System.getenv().
+   * @return true, if the system environment variables contain the Azure specific environment variable; false otherwise
    * @see <a href="https://docs.microsoft.com/en-us/azure/devops/pipelines/build/variables?view=azure-devops&tabs=yaml#build-variables">Azure DevOps - Build variables</a>
    */
   public static boolean isActiveServer(@Nonnull Map<String, String> env) {

core/src/main/java/pl/project13/core/cibuild/BambooBuildServerData.java

@@ -29,6 +29,11 @@ public class BambooBuildServerData extends BuildServerDataProvider {
     super(log, env);
   }
 
+  /**
+   * @param env The current system environment variables, obtained via System.getenv().
+   * @return true, if the system environment variables contain the Bamboo specific environment variable; false otherwise
+   * @see <a href="https://confluence.atlassian.com/bamboo/bamboo-variables-289277087.html#Bamboovariables-Build-specificvariables">Bamboo Variables</a>
+   */
   public static boolean isActiveServer(Map<String, String> env) {
     return env.containsKey("bamboo_buildKey") ||
             env.containsKey("bamboo.buildKey") ||

core/src/main/java/pl/project13/core/cibuild/CircleCiBuildServerData.java

@@ -31,6 +31,8 @@ public class CircleCiBuildServerData extends BuildServerDataProvider {
   }
 
   /**
+   * @param env The current system environment variables, obtained via System.getenv().
+   * @return true, if the system environment variables contain the Circle CI specific environment variable; false otherwise
    * @see <a href="https://circleci.com/docs/2.0/env-vars/#built-in-environment-variables">CircleCIBuiltInVariables</a>
    */
   public static boolean isActiveServer(Map<String, String> env) {

core/src/main/java/pl/project13/core/cibuild/GitHubBuildServerData.java

@@ -33,6 +33,8 @@ public class GitHubBuildServerData extends BuildServerDataProvider {
   }
 
   /**
+   * @param env The current system environment variables, obtained via System.getenv().
+   * @return true, if the system environment variables contain the Github specific environment variable; false otherwise
    * @see <a href="https://help.github.com/en/actions/automating-your-workflow-with-github-actions/using-environment-variables">GitHubActionsUsingEnvironmentVariables</a>
    */
   public static boolean isActiveServer(Map<String, String> env) {

core/src/main/java/pl/project13/core/cibuild/GitlabBuildServerData.java

@@ -31,6 +31,8 @@ public class GitlabBuildServerData extends BuildServerDataProvider {
   }
 
   /**
+   * @param env The current system environment variables, obtained via System.getenv().
+   * @return true, if the system environment variables contain the Gitlab specific environment variable; false otherwise
    * @see <a href="https://docs.gitlab.com/ce/ci/variables/predefined_variables.html">GitlabCIVariables</a>
    */
   public static boolean isActiveServer(Map<String, String> env) {

core/src/main/java/pl/project13/core/cibuild/HudsonJenkinsBuildServerData.java

@@ -31,6 +31,8 @@ public class HudsonJenkinsBuildServerData extends BuildServerDataProvider {
   }
 
   /**
+   * @param env The current system environment variables, obtained via System.getenv().
+   * @return true, if the system environment variables contain the Hudson/Jenkins specific environment variable; false otherwise
    * @see <a href="https://wiki.jenkins-ci.org/display/JENKINS/Building+a+software+project#Buildingasoftwareproject-JenkinsSetEnvironmentVariables">JenkinsSetEnvironmentVariables</a>
    */
   public static boolean isActiveServer(@Nonnull Map<String, String> env) {