From 5898cba4a8ea48804c569365153eb98b7a707923 Mon Sep 17 00:00:00 2001 From: Mark Harrah Date: Sun, 16 Oct 2011 20:20:45 -0400 Subject: [PATCH] brief API documentation on some core settings types --- util/collection/HList.scala | 2 ++ util/collection/KList.scala | 6 +++++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/util/collection/HList.scala b/util/collection/HList.scala index df0391de8..cb76594d0 100644 --- a/util/collection/HList.scala +++ b/util/collection/HList.scala @@ -5,6 +5,8 @@ package sbt import Types._ +/** A minimal heterogeneous list type. For background, see +* http://apocalisp.wordpress.com/2010/07/06/type-level-programming-in-scala-part-6a-heterogeneous-list basics/ */ sealed trait HList { type Wrap[M[_]] <: HList diff --git a/util/collection/KList.scala b/util/collection/KList.scala index 8035a4f2f..7b58aca32 100644 --- a/util/collection/KList.scala +++ b/util/collection/KList.scala @@ -8,7 +8,11 @@ import Types._ /** A higher-order heterogeneous list. It has a type constructor M[_] and * type parameters HL. The underlying data is M applied to each type parameter. * Explicitly tracking M[_] allows performing natural transformations or ensuring -* all data conforms to some common type. */ +* all data conforms to some common type. +* +* For background, see +* http://apocalisp.wordpress.com/2010/11/01/type-level-programming-in-scala-part-8a-klist%C2%A0motivation/ + */ sealed trait KList[+M[_], HL <: HList] { type Raw = HL