Skip to content

Commit

Permalink
Mention Dowel generated file naming scheme in Dowel and `DowelLis…
Browse files Browse the repository at this point in the history
…t` docs
  • Loading branch information
jayasuryat committed May 21, 2023
1 parent 1d915dd commit d762ac4
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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].
*
Expand Down

0 comments on commit d762ac4

Please sign in to comment.