Skip to content

Commit fb01d39

Browse files
committed
Improve documentation of PATH_ONLY watch scopes
1 parent 9095927 commit fb01d39

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

src/main/java/engineering/swat/watch/WatchScope.java

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,14 @@
55
*/
66
public enum WatchScope {
77
/**
8-
* Watch changes to a single file or (metadata of) a directory
8+
* Watch changes to a single file or (metadata of) a directory, but not its
9+
* content. That is, the following changes to a directory are watched:
10+
* - any modification caused by the creation of a nested file/directory;
11+
* - any modification caused by the deletion of a nested file/directory;
12+
* - any modification of its own metadata.
13+
*
14+
* When changes to nested files/directories should also be watched, use
15+
* PATH_AND_CHILDREN or PATH_AND_ALL_DESCENDANTS.
916
*/
1017
PATH_ONLY,
1118
/**

0 commit comments

Comments
 (0)