Skip to content

Commit 07841b0

Browse files
committed
docs(model): Update the KDoc for Project.vcsProcessed
While `Project.vcs` only contains information from the metadata of the project, `Project.vcsProcessed`, according to various package manager implementations, may additionally contain information derived from the version control system. So, update the documentation to reflect the implementation. Signed-off-by: Frank Viernau <frank.viernau@gmail.com>
1 parent 420f78a commit 07841b0

1 file changed

Lines changed: 1 addition & 0 deletions

File tree

model/src/main/kotlin/Project.kt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@ data class Project(
8282

8383
/**
8484
* Processed VCS-related information about the [Project] that has e.g. common mistakes corrected.
85+
* The information originates from [vcs], and optionally also from the code repository of the project.
8586
*/
8687
val vcsProcessed: VcsInfo = vcs.normalize(),
8788

0 commit comments

Comments
 (0)