Skip to content

Commit 021d66e

Browse files
committed
updated trackSourceFiles comments per #836 (comment)
1 parent 06a8fe6 commit 021d66e

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

gradle-plugin/src/main/java/com/squareup/anvil/plugin/AnvilExtension.kt

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,10 @@ public abstract class AnvilExtension @Inject constructor(
9494
.conventionFromProperty("com.squareup.anvil.addOptionalAnnotations", false)
9595

9696
/**
97-
* Track the source files for each generated file. This allows for two new behaviors:
97+
* Enables incremental compilation support.
98+
*
99+
* This is achieved by maintaining a link between source files that exist before Anvil is run
100+
* and the Anvil-generated files. This allows for two new behaviors:
98101
* - Generated code is "invalidated" and deleted when the source file is changed or deleted.
99102
* - Generated code is cached in a way that Gradle understands,
100103
* and will be restored from cache along with other build artifacts.

gradle-plugin/src/main/java/com/squareup/anvil/plugin/VariantFilter.kt

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,15 @@ public interface VariantFilter : Named {
4343
*/
4444
public var addOptionalAnnotations: Boolean
4545

46+
/**
47+
* Enables incremental compilation support.
48+
*
49+
* This is achieved by maintaining a link between source files that exist before Anvil is run
50+
* and the Anvil-generated files. This allows for two new behaviors:
51+
* - Generated code is "invalidated" and deleted when the source file is changed or deleted.
52+
* - Generated code is cached in a way that Gradle understands,
53+
* and will be restored from cache along with other build artifacts.
54+
*/
4655
public var trackSourceFiles: Boolean
4756
}
4857

0 commit comments

Comments
 (0)