Skip to content

Commit d36dfb9

Browse files
committed
Add a note to the documentation for JctFileManager about compiler usage
1 parent a50fe2c commit d36dfb9

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

java-compiler-testing/src/main/java/io/github/ascopes/jct/filemanagers/JctFileManager.java

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
import io.github.ascopes.jct.containers.OutputContainerGroup;
2020
import io.github.ascopes.jct.containers.PackageContainerGroup;
2121
import io.github.ascopes.jct.workspaces.PathRoot;
22+
import io.github.ascopes.jct.workspaces.Workspace;
2223
import java.io.IOException;
2324
import java.util.Collection;
2425
import java.util.Set;
@@ -34,6 +35,12 @@
3435
* Extension around a {@link JavaFileManager} that allows adding of {@link PathRoot} objects to the
3536
* manager.
3637
*
38+
* <p>This component is responsible for bridging the gap between a {@link Workspace} and
39+
* a {@link javax.tools.JavaCompiler} when performing a compilation, and thus includes a number of
40+
* required operations that the compiler will query the file system with. In addition, this
41+
* interface also defines a number of additional functionalities that are useful for querying and
42+
* verifying the outcome of compilations within tests.
43+
*
3744
* @author Ashley Scopes
3845
* @since 0.0.1
3946
*/

0 commit comments

Comments
 (0)