Cleanup Javadoc (#364,#366)

Author: ysb33r

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 {