From d762ac494e491d07e7d5d16a9ee8284351087b5d Mon Sep 17 00:00:00 2001 From: JayaSuryaT Date: Sun, 21 May 2023 16:14:27 +0530 Subject: [PATCH] Mention `Dowel` generated file naming scheme in `Dowel` and `DowelList` docs --- .../src/main/java/com/jayasuryat/dowel/annotation/Dowel.kt | 2 ++ .../main/java/com/jayasuryat/dowel/annotation/DowelList.kt | 4 +++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/dowel-annotation/src/main/java/com/jayasuryat/dowel/annotation/Dowel.kt b/dowel-annotation/src/main/java/com/jayasuryat/dowel/annotation/Dowel.kt index faa3f43..fc1c088 100644 --- a/dowel-annotation/src/main/java/com/jayasuryat/dowel/annotation/Dowel.kt +++ b/dowel-annotation/src/main/java/com/jayasuryat/dowel/annotation/Dowel.kt @@ -26,6 +26,8 @@ import com.jayasuryat.dowel.annotation.internal.DowelInternal * The generated PreviewParameterProvider will have [count] number of objects in the sequence of * values, and the objects would be constructed using the primary constructor of the annotated class. * All properties with default values would be ignored, and nullable types would be null randomly. + * **The name of the generated PreviewParameterProvider class will follow + * "<Annotated class's name>PreviewParameterProvider" format**. * * The annotated class must be a concrete class, class should not have any generic type parameters, * and all of the properties listed in the primary constructor can only be of the following types: diff --git a/dowel-annotation/src/main/java/com/jayasuryat/dowel/annotation/DowelList.kt b/dowel-annotation/src/main/java/com/jayasuryat/dowel/annotation/DowelList.kt index 2c520ad..9e5a32f 100644 --- a/dowel-annotation/src/main/java/com/jayasuryat/dowel/annotation/DowelList.kt +++ b/dowel-annotation/src/main/java/com/jayasuryat/dowel/annotation/DowelList.kt @@ -21,7 +21,9 @@ import com.jayasuryat.dowel.annotation.internal.DowelInternal * This annotation builds on top of what already @[Dowel] annotation is doing. * * Generates a PreviewParameterProvider of type List<T> where T is the class annotated - * with [DowelList] annotation. Rest of the behavior is same as the @[Dowel] annotation. + * with [DowelList] annotation. **The name of the generated PreviewParameterProvider class will + * follow "<Annotated class's name>ListPreviewParamProvider" format**. Rest of the behavior is + * same as the @[Dowel] annotation. * * **Note** : Only classes already annotated with @[Dowel] can be annotated with @[DowelList]. *