Ensure all new classes have reasonable groovydoc/javadoc (jruby-gradl…

…e#364)
ysb33r · Jun 1, 2019 · 72fc773 · 72fc773
1 parent 64513da
commit 72fc773
Show file tree

Hide file tree

Showing 14 changed files with 410 additions and 202 deletions.
diff --git a/core-plugin/src/main/groovy/com/github/jrubygradle/core/ApiException.groovy b/core-plugin/src/main/groovy/com/github/jrubygradle/core/ApiException.groovy
@@ -5,6 +5,7 @@ import groovy.transform.InheritConstructors
 
 /** Throws when there are issues with the RubyGems REST API.
  *
+ * @since 2.0
  */
 @InheritConstructors
 @CompileStatic

diff --git a/core-plugin/src/main/groovy/com/github/jrubygradle/core/GemDependency.java b/core-plugin/src/main/groovy/com/github/jrubygradle/core/GemDependency.java
@@ -1,7 +1,20 @@
 package com.github.jrubygradle.core;
 
+/** Description of a transitive GEM dependency.
+ *
+ * @since 2.0
+ */
 public interface GemDependency {
+
+    /** Name of transitive GEM dependency.
+     *
+     * @return GEM name
+     */
     String getName();
 
+    /** Version requirements that is requested upon this transitive dependency.
+     *
+      * @return Version requirements in GEM format.
+     */
     String getRequirements();
 }
diff --git a/core-plugin/src/main/groovy/com/github/jrubygradle/core/GemInfo.java b/core-plugin/src/main/groovy/com/github/jrubygradle/core/GemInfo.java
@@ -3,6 +3,10 @@
 import java.net.URI;
 import java.util.List;
 
+/** GEM metadata.
+ *
+ * @since 2.0
+ */
 public interface GemInfo {
 
     /** GEM name.