Skip to content

Commit aa0d7bb

Browse files
committed
Ensure all new classes have reasonable groovydoc/javadoc (#364)
1 parent fe44c08 commit aa0d7bb

14 files changed

+410
-202
lines changed

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import groovy.transform.InheritConstructors
55

66
/** Throws when there are issues with the RubyGems REST API.
77
*
8+
* @since 2.0
89
*/
910
@InheritConstructors
1011
@CompileStatic
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,20 @@
11
package com.github.jrubygradle.core;
22

3+
/** Description of a transitive GEM dependency.
4+
*
5+
* @since 2.0
6+
*/
37
public interface GemDependency {
8+
9+
/** Name of transitive GEM dependency.
10+
*
11+
* @return GEM name
12+
*/
413
String getName();
514

15+
/** Version requirements that is requested upon this transitive dependency.
16+
*
17+
* @return Version requirements in GEM format.
18+
*/
619
String getRequirements();
720
}

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

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,10 @@
33
import java.net.URI;
44
import java.util.List;
55

6+
/** GEM metadata.
7+
*
8+
* @since 2.0
9+
*/
610
public interface GemInfo {
711

812
/** GEM name.

0 commit comments

Comments
 (0)