Skip to content

Commit bb751b8

Browse files
committed
More corrections in documentation.
1 parent 1e1757c commit bb751b8

File tree

3 files changed

+7
-6
lines changed

3 files changed

+7
-6
lines changed

api/maven-api-core/src/main/java/org/apache/maven/api/SourceRoot.java

+2
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,8 @@ default Path directory() {
5555
* <p>
5656
* The default implementation returns an empty list, which means to apply a language-dependent pattern.
5757
* For example, for the Java language, the pattern includes all files with the {@code .java} suffix.
58+
*
59+
* @see java.nio.file.FileSystem#getPathMatcher(String)
5860
*/
5961
default List<String> includes() {
6062
return List.of();

impl/maven-impl/src/main/java/org/apache/maven/impl/DefaultSourceRoot.java

+4-4
Original file line numberDiff line numberDiff line change
@@ -153,8 +153,8 @@ public DefaultSourceRoot(final ProjectScope scope, final Language language, fina
153153
* @param scope scope of source code (main or test)
154154
* @param language language of the source code
155155
* @param directory directory of the source code
156-
* @param includes list of patterns for the files to include, or {@code null} if unspecified
157-
* @param excludes list of patterns for the files to exclude, or {@code null} if nothing to exclude
156+
* @param includes patterns for the files to include, or {@code null} or empty if unspecified
157+
* @param excludes patterns for the files to exclude, or {@code null} or empty if nothing to exclude
158158
*/
159159
public DefaultSourceRoot(
160160
final ProjectScope scope,
@@ -196,7 +196,7 @@ public Path directory() {
196196
}
197197

198198
/**
199-
* {@return the list of patterns for the files to include}.
199+
* {@return the patterns for the files to include}.
200200
*/
201201
@Override
202202
@SuppressWarnings("ReturnOfCollectionOrArrayField") // Safe because unmodifiable
@@ -205,7 +205,7 @@ public List<String> includes() {
205205
}
206206

207207
/**
208-
* {@return the list of patterns for the files to exclude}.
208+
* {@return the patterns for the files to exclude}.
209209
*/
210210
@Override
211211
@SuppressWarnings("ReturnOfCollectionOrArrayField") // Safe because unmodifiable

impl/maven-impl/src/main/java/org/apache/maven/impl/PathSelector.java

+1-2
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
import java.util.Set;
3131

3232
/**
33-
* Determines whether a path is selected according include/exclude patterns.
33+
* Determines whether a path is selected according to include/exclude patterns.
3434
* The pathnames used for method parameters will be relative to some base directory
3535
* and use {@code '/'} as separator, regardless the hosting operating system.
3636
*
@@ -463,7 +463,6 @@ private static void append(StringBuilder buffer, String label, String[] patterns
463463

464464
/**
465465
* {@return a string representation for logging purposes}.
466-
* This string representation is reported logged when {@link Cleaner} is executed.
467466
*/
468467
@Override
469468
public String toString() {

0 commit comments

Comments
 (0)