From 722d4ff614893b8f9757fc12261cf1da5b375cb7 Mon Sep 17 00:00:00 2001 From: Alexandre Archambault Date: Thu, 18 Jun 2015 17:52:32 +0100 Subject: [PATCH] Add comments --- .../main/scala/coursier/core/Definitions.scala | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/core/src/main/scala/coursier/core/Definitions.scala b/core/src/main/scala/coursier/core/Definitions.scala index 223aa8d2d..cffbb5fb2 100644 --- a/core/src/main/scala/coursier/core/Definitions.scala +++ b/core/src/main/scala/coursier/core/Definitions.scala @@ -1,5 +1,14 @@ package coursier.core +/** + * Identify a "module". + * + * During resolution, all dependencies having the same module + * will be given the same version, if there are no version conflicts + * between them. + * + * Ivy attributes would land here, if support for Ivy is added. + */ case class Module(organization: String, name: String) { @@ -12,6 +21,12 @@ case class Module(organization: String, sealed abstract class Scope(val name: String) +/** + * Dependencies with the same @module will typically see their @version-s merged. + * + * The remaining fields are left untouched, some being transitively + * propagated (exclusions, optional, in particular). + */ case class Dependency(module: Module, version: String, scope: Scope,