Cleanup Javadoc (jruby-gradle#364,jruby-gradle#366)

base-plugin/src/main/groovy/com/github/jrubygradle/GenerateGradleRb.groovy

@@ -19,6 +19,9 @@ import static com.github.jrubygradle.internal.JRubyExecUtils.classpathFromConfig
  * performing local manual testing.
  *
  * @author Schalk W. Cronjé
+ * @author R Tyler Croy
+ * @author Christian Meier
+ *
  * @since 0.1.15
  */
 @SuppressWarnings('UnnecessaryGetter')

base-plugin/src/main/groovy/com/github/jrubygradle/JRubyExec.groovy

@@ -21,6 +21,9 @@ import static org.ysb33r.grolifant.api.StringUtils.stringize
 /** Runs a ruby script using JRuby
  *
  * @author Schalk W. Cronjé
+ * @author R Tyler Croy
+ * @author Christian Meier
+ *
  */
 class JRubyExec extends JavaExec implements JRubyAwareTask, JRubyExecSpec {
 

base-plugin/src/main/groovy/com/github/jrubygradle/JRubyPlugin.groovy

@@ -12,6 +12,10 @@ import org.gradle.api.artifacts.Configuration
 import static org.ysb33r.grolifant.api.TaskProvider.registerTask
 
 /** Base plugin for JRuby.
+ *
+ * @author Schalk W. Cronjé
+ * @author R Tyler Croy
+ * @author Christian Meier
  *
  */
 @CompileStatic

base-plugin/src/main/groovy/com/github/jrubygradle/JRubyPluginExtension.groovy

@@ -18,7 +18,12 @@ import java.util.concurrent.Callable
 import static org.ysb33r.grolifant.api.StringUtils.stringize
 
 /**
- * Class providing the jruby{} DSL extension to the Gradle build script
+ * Class providing the jruby{} DSL extension to the Gradle build script.
+ *
+ * @author Schalk W. Cronjé
+ * @author R Tyler Croy
+ * @author Christian Meier
+ *
  */
 @CompileStatic
 class JRubyPluginExtension extends AbstractCombinedProjectTaskExtension {

base-plugin/src/main/groovy/com/github/jrubygradle/JRubyPrepare.groovy

@@ -4,7 +4,8 @@ import com.github.jrubygradle.api.core.AbstractJRubyPrepare
 import com.github.jrubygradle.internal.JRubyExecUtils
 import groovy.transform.CompileStatic
 
-/**
+/** Task for preparing a project-local installation of GEMs & JARs.
+ *
  * @author Schalk W. Cronjé
  * @author R Tyler Croy
  * @author Christian Meier

base-plugin/src/main/groovy/com/github/jrubygradle/UninitialisedParameterException.groovy

@@ -4,6 +4,8 @@ import groovy.transform.CompileStatic
 import groovy.transform.InheritConstructors
 
 /** Thrown when a parameter has not been correctly initialised.
+ *
+ * @author Schalk W. Cronjé
  *
  * @since 2.0
  */

base-plugin/src/main/groovy/com/github/jrubygradle/internal/JRubyExecDelegate.groovy

@@ -15,8 +15,11 @@ import static com.github.jrubygradle.internal.JRubyExecUtils.prepareJRubyEnviron
 import static com.github.jrubygradle.internal.JRubyExecUtils.resolveScript
 import static org.ysb33r.grolifant.api.StringUtils.stringize
 
-/**
+/** Delegate for running JRuby using {@code project.jrubyexec}.
+ *
  * @author Schalk W. Cronjé
+ * @author R Tyler Croy
+ *
  */
 class JRubyExecDelegate {
 

base-plugin/src/main/groovy/com/github/jrubygradle/internal/JRubyExecUtils.groovy

@@ -16,8 +16,12 @@ import java.util.regex.Matcher
 
 import static org.ysb33r.grolifant.api.StringUtils.stringize
 
-/**
- * @author Schalk W. Cronjé.
+/** Utilities for preparation or executing JRuby.
+ *
+ * @author Schalk W. Cronjé
+ * @author R Tyler Croy
+ * @author Christian Meier
+ *
  */
 @CompileStatic
 class JRubyExecUtils {

core-plugin/src/main/groovy/com/github/jrubygradle/api/core/ApiException.groovy

@@ -4,6 +4,8 @@ import groovy.transform.CompileStatic
 import groovy.transform.InheritConstructors
 
 /** Throws when there are issues with the RubyGems REST API.
+ *
+ * @author Schalk W. Cronjé
  *
  * @since 2.0
  */

core-plugin/src/main/groovy/com/github/jrubygradle/api/core/IvyXmlProxyServer.java

@@ -7,6 +7,8 @@
  * Proxy service which can translate RubyGems structures into Ivy structures
  * and vice-versa.
  *
+ * @author Schalk W. Cronjé
+ *
  * @since 2.0
  */
 public interface IvyXmlProxyServer extends Runnable {

core-plugin/src/main/groovy/com/github/jrubygradle/api/core/JRubyAwareTask.java

@@ -2,7 +2,9 @@
 
 import org.gradle.api.Task;
 
-/** For tasks that require JRUby in some form
+/** For tasks that require JRuby in some form
+ *
+ * @author Schalk W. Cronjé
  *
  * @since 2.0
  */

core-plugin/src/main/groovy/com/github/jrubygradle/api/core/JRubyCorePlugin.groovy

@@ -11,6 +11,8 @@ import org.gradle.api.plugins.ExtensionAware
 /** Provides only a repository handler extensiosn for looking up rubygem
  * metadata.
  *
+ * @author Schalk W. Cronjé
+ *
  * @since 2.0
  */
 @CompileStatic

core-plugin/src/main/groovy/com/github/jrubygradle/api/core/JRubyExecSpec.java

@@ -9,6 +9,7 @@
  * Formalises a way of executing JRuby from Gradle via an execution specification
  *
  * @author Schalk W. Cronjé
+ *
  * @since 2.0
  */
 public interface JRubyExecSpec extends JavaExecSpec {

core-plugin/src/main/groovy/com/github/jrubygradle/api/core/RepositoryHandlerExtension.groovy

@@ -10,6 +10,8 @@ import org.gradle.api.artifacts.repositories.IvyArtifactRepository
 import org.gradle.util.GradleVersion
 
 /** Extension which can be added to {@code project.repositories}.
+ *
+ * @author Schalk W. Cronjé
  *
  * @since 2.0
  */

core-plugin/src/main/groovy/com/github/jrubygradle/api/core/RubyGemQueryRestApi.java

@@ -5,6 +5,8 @@
 import java.util.List;
 
 /** Interface for querying a service that confirorms to the RubyGem API.
+ *
+ * @author Schalk W. Cronjé
  *
  * @since 2.0.
  *

core-plugin/src/main/groovy/com/github/jrubygradle/api/gems/GemDependency.java

@@ -1,6 +1,8 @@
 package com.github.jrubygradle.api.gems;
 
 /** Description of a transitive GEM dependency.
+ *
+ * @author Schalk W. Cronjé
  *
  * @since 2.0
  */

core-plugin/src/main/groovy/com/github/jrubygradle/api/gems/GemGroups.groovy

@@ -3,9 +3,9 @@ package com.github.jrubygradle.api.gems
 import com.github.jrubygradle.api.core.RepositoryHandlerExtension
 import groovy.transform.CompileStatic
 
-import static RepositoryHandlerExtension.DEFAULT_GROUP_NAME
+import static com.github.jrubygradle.api.core.RepositoryHandlerExtension.DEFAULT_GROUP_NAME
 
-/**
+/** Defines groups which contains GEMs
  *
  * @author Schalk W. Cronjé
  *

core-plugin/src/main/groovy/com/github/jrubygradle/api/gems/GemInfo.java

@@ -4,6 +4,8 @@
 import java.util.List;
 
 /** GEM metadata.
+ *
+ * @author Schalk W. Cronjé
  *
  * @since 2.0
  */

core-plugin/src/main/groovy/com/github/jrubygradle/api/gems/GemInstallException.groovy

@@ -4,6 +4,8 @@ import groovy.transform.CompileStatic
 import groovy.transform.InheritConstructors
 
 /** Throws when there are issues installing and extracting GEMs.
+ *
+ * @author Schalk W. Cronjé
  *
  * @since 2.0
  */

core-plugin/src/main/groovy/com/github/jrubygradle/api/gems/GemOverwriteAction.groovy

@@ -4,6 +4,11 @@ import groovy.transform.CompileStatic
 
 /** Overwrite actions when installing GEMs locally into the build area
  *
+ * @author Schalk W. Cronjé
+ * @author R Tyler Croy
+ * @author Christian Meier
+ *
+ * @since 2.0
  */
 @CompileStatic
 enum GemOverwriteAction {

core-plugin/src/main/groovy/com/github/jrubygradle/api/gems/GemUtils.groovy

@@ -20,6 +20,8 @@ import static com.github.jrubygradle.api.gems.GemOverwriteAction.OVERWRITE
  *
  * @author R Tyler Croy
  * @author Schalk W. Cronjé
+ *
+ * @since 2.0
  */
 @CompileStatic
 class GemUtils {

core-plugin/src/main/groovy/com/github/jrubygradle/api/gems/GemVersionException.groovy

@@ -5,6 +5,8 @@ import groovy.transform.CompileStatic
 import groovy.transform.InheritConstructors
 
 /** Thrown when GEM version strings cannot be correctly parsed.
+ *
+ * @author Schalk W. Cronjé
  *
  * @since 2.0
  */

core-plugin/src/main/groovy/com/github/jrubygradle/internal/core/DefaultRubyGemRestApi.groovy

@@ -16,6 +16,8 @@ import static groovyx.net.http.OkHttpBuilder.configure
 /** Implementation for a RubyGems REST API client based upon
  * HttpBuilder-ng.
  *
+ * @author Schalk W. Cronjé
+ *
  * @since 2.0
  */
 @CompileStatic

core-plugin/src/main/groovy/com/github/jrubygradle/internal/core/IvyUtils.groovy

@@ -5,6 +5,8 @@ import groovy.transform.CompileStatic
 import groovy.xml.MarkupBuilder
 
 /** Utilities for dealing with Ivy formats.
+ *
+ * @author Schalk W. Cronjé
  *
  * @since 2.0
  */

core-plugin/src/main/groovy/com/github/jrubygradle/internal/core/IvyXmlGlobalProxyRegistry.groovy

@@ -9,7 +9,9 @@ import java.util.concurrent.ConcurrentMap
 
 /** Allow only one version of the proxy to run.
  *
- * @Since 2.0
+ * @author Schalk W. Cronjé
+ *
+ * @since 2.0
  */
 @CompileStatic
 class IvyXmlGlobalProxyRegistry {

core-plugin/src/main/groovy/com/github/jrubygradle/internal/core/IvyXmlRatpackProxyServer.groovy

@@ -23,6 +23,8 @@ import static java.nio.file.StandardCopyOption.REPLACE_EXISTING
 /** Uses Ratpack to run a small proxy server inside Gradle to proxy Rubygems.org
  * as if it is local Ivy server with remote artifacts.
  *
+ * @author Schalk W. Cronjé
+ *
  * @since 2.0
  */
 @CompileStatic

core-plugin/src/main/groovy/com/github/jrubygradle/internal/gems/DefaultGemDependency.groovy

@@ -4,6 +4,8 @@ import com.github.jrubygradle.api.gems.GemDependency
 import groovy.transform.CompileStatic
 
 /** Defining a GEM dependency.
+ *
+ * @author Schalk W. Cronjé
  *
  * @since 2.0
  */

core-plugin/src/main/groovy/com/github/jrubygradle/internal/gems/DefaultGemInfo.groovy

@@ -8,6 +8,8 @@ import groovy.transform.CompileStatic
  *
  * Elements in this class match directly to the Rubgems REST API.
  *
+ * @author Schalk W. Cronjé
+ *
  * @since 2.0
  */
 @CompileStatic

core-plugin/src/main/groovy/com/github/jrubygradle/internal/gems/GemToIvy.groovy

@@ -10,6 +10,8 @@ import java.security.MessageDigest
 import static com.github.jrubygradle.api.gems.GemVersion.singleGemVersionFromMultipleGemRequirements
 
 /** Converts from Gem metadata to Ivy metadata.
+ *
+ * @author Schalk W. Cronjé
  *
  * @since 2.0
  */

core-plugin/src/main/groovy/com/github/jrubygradle/internal/gems/GemVersionResolver.groovy

@@ -14,6 +14,11 @@ import static com.github.jrubygradle.api.gems.GemVersion.gemVersionFromGradleIvy
 
 /**
  * Resolver to compute gem versions
+ *
+ * @author Schalk W. Cronjé
+ * @author Christian Meier
+ *
+ * @since 2.0
  */
 class GemVersionResolver {
     static void addGemResolver(Configuration cfg, GemGroups gemGroups, GemVersionResolver versionResolver) {