annotate the purpose of the Inject classes

twitter · Dec 10, 2015 · 62505f4 · 62505f4
1 parent 4c9b73d
commit 62505f4
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 0 deletions.
diff --git a/algebird-core/src/main/scala/com/twitter/algebird/maps/increment.scala b/algebird-core/src/main/scala/com/twitter/algebird/maps/increment.scala
@@ -84,6 +84,7 @@ package tree {
 import tree._
 
 package infra {
+  /** Dependency injection for [[IncrementMap]].  Supplies implementations of all abstract methods */
   class Inject[K, V](val keyOrdering: Ordering[K], val valueMonoid: Monoid[V])
     extends Serializable {
     def iNode(clr: Color, dat: Data[K], ls: Node[K], rs: Node[K]) =

diff --git a/algebird-core/src/main/scala/com/twitter/algebird/maps/nearest.scala b/algebird-core/src/main/scala/com/twitter/algebird/maps/nearest.scala
@@ -141,6 +141,7 @@ package tree {
 import tree._
 
 package infra {
+  /** Dependency injection for [[NearestSet]].  Supplies implementations of all abstract methods */
   class InjectSet[K](val keyOrdering: Numeric[K]) extends Serializable {
     def iNode(clr: Color, dat: Data[K], ls: Node[K], rs: Node[K]) =
       new InjectSet[K](keyOrdering) with INodeNear[K] with NearestSet[K] {
@@ -161,6 +162,7 @@ package infra {
       }
   }
 
+  /** Dependency injection for [[NearestMap]].  Supplies implementations of all abstract methods */
   class InjectMap[K, V](val keyOrdering: Numeric[K]) extends Serializable {
     def iNode(clr: Color, dat: Data[K], ls: Node[K], rs: Node[K]) =
       new InjectMap[K, V](keyOrdering) with INodeNearMap[K, V] with NearestMap[K, V] {

diff --git a/algebird-core/src/main/scala/com/twitter/algebird/maps/ordered.scala b/algebird-core/src/main/scala/com/twitter/algebird/maps/ordered.scala
@@ -110,6 +110,7 @@ package infra {
     }
   }
 
+  /** Dependency injection for [[OrderedSet]].  Supplies implementations of all abstract methods */
   class InjectSet[K](val keyOrdering: Ordering[K]) extends Serializable {
     def iNode(clr: Color, dat: Data[K], ls: Node[K], rs: Node[K]) =
       new InjectSet[K](keyOrdering) with INode[K] with OrderedSet[K] {
@@ -121,6 +122,7 @@ package infra {
       }
   }
 
+  /** Dependency injection for [[OrderedMap]].  Supplies implementations of all abstract methods */
   class InjectMap[K, V](val keyOrdering: Ordering[K]) extends Serializable {
     def iNode(clr: Color, dat: Data[K], ls: Node[K], rs: Node[K]) =
       new InjectMap[K, V](keyOrdering) with INodeMap[K, V] with OrderedMap[K, V] {

diff --git a/algebird-core/src/main/scala/com/twitter/algebird/maps/prefixsum.scala b/algebird-core/src/main/scala/com/twitter/algebird/maps/prefixsum.scala
@@ -79,6 +79,7 @@ import tree._
 package infra {
   import com.twitter.algebird.maps.ordered.tree.DataMap
 
+  /** Dependency injection for [[PrefixSumMap]].  Supplies implementations of all abstract methods */
   class Inject[K, V, P](val keyOrdering: Ordering[K], val prefixAggregator: MonoidAggregator[V, P, P])
     extends Serializable {
     def iNode(clr: Color, dat: Data[K], ls: Node[K], rs: Node[K]) =