Skip to content

Commit a9ba2b4

Browse files
committed
Improve documentation for GH-370 code changes.
1 parent 2c97710 commit a9ba2b4

File tree

1 file changed

+8
-8
lines changed
  • java-compiler-testing/src/main/java/io/github/ascopes/jct/workspaces

1 file changed

+8
-8
lines changed

java-compiler-testing/src/main/java/io/github/ascopes/jct/workspaces/FileBuilder.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,8 @@
3434
public interface FileBuilder {
3535

3636
/**
37-
* Take the managed directory that is given as a parameter, and convert it into a JAR
38-
* file that will be written to this file being created.
37+
* Take the directory, represented by the given {@link ManagedDirectory}, and convert it into a
38+
* JAR file, that will be written to the file being created.
3939
*
4040
* <pre><code>
4141
* // Compile some files first.
@@ -60,8 +60,8 @@ public interface FileBuilder {
6060
ManagedDirectory asJarFrom(ManagedDirectory directory);
6161

6262
/**
63-
* Take the directory represented by the given path that is given as a parameter, and
64-
* convert it into a JAR file that will be written to this file being created.
63+
* Take the directory, represented by the given path, and convert it into a JAR file, that will be
64+
* written to the file being created.
6565
*
6666
* <pre><code>
6767
* ManagedDirectory someDirectory = ...;
@@ -246,8 +246,8 @@ public interface FileBuilder {
246246
* </code></pre>
247247
*
248248
* <p>If the Java language level of your tests does not support multi-line strings, you can
249-
* alternatively pass each line of text to write as a separate string. These will be written
250-
* to the file using line-feed {@code '\n'} separators. For example:
249+
* alternatively pass each line of text to write as a separate string. These will be written to
250+
* the file using line-feed {@code '\n'} separators. For example:
251251
*
252252
* <pre><code>
253253
* directory
@@ -292,8 +292,8 @@ public interface FileBuilder {
292292
* </code></pre>
293293
*
294294
* <p>If the Java language level of your tests does not support multi-line strings, you can
295-
* alternatively pass each line of text to write as a separate string. These will be written
296-
* to the file using line-feed {@code '\n'} separators. For example:
295+
* alternatively pass each line of text to write as a separate string. These will be written to
296+
* the file using line-feed {@code '\n'} separators. For example:
297297
*
298298
* <pre><code>
299299
* directory

0 commit comments

Comments
 (0)