Skip to content

Commit 9eefdbc

Browse files
committed
Address Javadoc warnings
1 parent cf0e90e commit 9eefdbc

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed

src/main/java/org/gradlex/javamodule/testing/JavaModuleTestingExtension.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,8 @@ public JavaModuleTestingExtension(Project project, JavaModuleDetector moduleDete
5757
* For example:
5858
*
5959
* javaModuleTesting.blackbox(testing.suites["integtest"])
60+
*
61+
* @param jvmTestSuite the JVM Test Suite to configure
6062
*/
6163
public void blackbox(TestSuite jvmTestSuite) {
6264
if (jvmTestSuite instanceof JvmTestSuite) {
@@ -69,6 +71,8 @@ public void blackbox(TestSuite jvmTestSuite) {
6971
* For example:
7072
*
7173
* javaModuleTesting.whitebox(testing.suites["test"])
74+
*
75+
* @param jvmTestSuite the JVM Test Suite to configure
7276
*/
7377
public void whitebox(TestSuite jvmTestSuite) {
7478
whitebox(jvmTestSuite, NO_OP_ACTION);
@@ -85,6 +89,9 @@ public void whitebox(TestSuite jvmTestSuite) {
8589
* requires.add("org.junit.jupiter.api")
8690
* opensTo.add("org.junit.platform.commons")
8791
* }
92+
*
93+
* @param jvmTestSuite the JVM Test Suite to configure
94+
* @param conf configuration details for the whitebox test setup
8895
*/
8996
public void whitebox(TestSuite jvmTestSuite, Action<WhiteboxJvmTestSuite> conf) {
9097
if (jvmTestSuite instanceof JvmTestSuite) {

src/main/java/org/gradlex/javamodule/testing/WhiteboxJvmTestSuite.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,19 +25,25 @@ public interface WhiteboxJvmTestSuite {
2525
/**
2626
* Configure which source set contains the 'sources under test' for
2727
* this Whitebox Test Suite - defaults to 'main'.
28+
*
29+
* @return the source set under test
2830
*/
2931
Property<SourceSet> getSourcesUnderTest();
3032

3133
/**
3234
* Add additional 'requires' directives for the test code.
3335
* For example, 'requires.add("org.junit.jupiter.api")'.
36+
*
37+
* @return modifiable list of addition 'requires' (--add-reads)
3438
*/
3539
ListProperty<String> getRequires();
3640

3741
/**
3842
* Open all packages of this Whitebox Test Suite to a given Module
3943
* for reflection at runtime.
4044
* For example, 'opensTo.add("org.junit.platform.commons")'.
45+
*
46+
* @return modifiable list of addition '--add-opens'
4147
*/
4248
ListProperty<String> getOpensTo();
4349
}

0 commit comments

Comments
 (0)