Add some doccomments

1 files changed, 9 insertions, 0 deletions

diff --git a/core/src/main/scala/mill/define/Module.scala b/core/src/main/scala/mill/define/Module.scala
index db1d511a..c9240fa0 100644
--- a/core/src/main/scala/mill/define/Module.scala
+++ b/core/src/main/scala/mill/define/Module.scala
@@ -12,6 +12,15 @@ object Segment{
 }
 
 case class BasePath(value: Path)
+
+/**
+  * Models a path with the Mill build hierarchy, e.g.
+  *
+  * amm.util[2.11].test.compile
+  *
+  * .-separated segments are [[Segment.Label]]s, while []-delimited
+  * segments are [[Segment.Cross]]s
+  */
 case class Segments(value: Segment*){
   def ++(other: Seq[Segment]): Segments = Segments(value ++ other:_*)
   def ++(other: Segments): Segments = Segments(value ++ other.value:_*)