Merge pull request #26 from lightbend/docs

Added some code documentation, updated version to 0.1.0

Author: debasishg

build.sbt

@@ -4,7 +4,7 @@ name := "kafka-streams-scala"
 
 organization := "com.lightbend"
 
-version := "0.0.1"
+version := "0.1.0"
 
 scalaVersion := Versions.Scala_2_12_Version
 

src/main/scala/com/lightbend/kafka/scala/streams/FunctionConversions.scala

@@ -3,6 +3,11 @@ package com.lightbend.kafka.scala.streams
 import org.apache.kafka.streams.KeyValue
 import org.apache.kafka.streams.kstream._
 
+/**
+ * Implicit classes that offer conversions of Scala function literals to 
+ * SAM (Single Abstract Method) objects in Java. These make the Scala APIs much
+ * more expressive, with less boilerplate and more succinct.
+ */ 
 object FunctionConversions {
 
   implicit class PredicateFromFunction[K, V](val test: (K, V) => Boolean) extends AnyVal {

src/main/scala/com/lightbend/kafka/scala/streams/ImplicitConversions.scala

@@ -5,6 +5,10 @@ import org.apache.kafka.streams.KeyValue
 
 import scala.language.implicitConversions
 
+/**
+ * Implicit conversions between the Scala wrapper objects and the underlying Java
+ * objects.
+ */ 
 object ImplicitConversions {
 
   implicit def wrapKStream[K, V](inner: KStream[K, V]): KStreamS[K, V] =

src/main/scala/com/lightbend/kafka/scala/streams/KGroupedStreamS.scala

@@ -8,6 +8,9 @@ import ImplicitConversions._
 import FunctionConversions._
 
 
+/**
+ * Wraps the Java class KGroupedStream and delegates method calls to the underlying Java object.
+ */ 
 class KGroupedStreamS[K, V](inner: KGroupedStream[K, V]) {
 
   def count(): KTableS[K, Long] = {

src/main/scala/com/lightbend/kafka/scala/streams/KGroupedTableS.scala

@@ -6,6 +6,9 @@ import org.apache.kafka.streams.state.KeyValueStore
 import org.apache.kafka.common.utils.Bytes
 import FunctionConversions._
 
+/**
+ * Wraps the Java class KGroupedTable and delegates method calls to the underlying Java object.
+ */ 
 class KGroupedTableS[K, V](inner: KGroupedTable[K, V]) {
 
   type ByteArrayKVStore = KeyValueStore[Bytes, Array[Byte]]

src/main/scala/com/lightbend/kafka/scala/streams/KStreamS.scala

@@ -8,6 +8,9 @@ import FunctionConversions._
 
 import scala.collection.JavaConverters._
 
+/**
+ * Wraps the Java class KStream and delegates method calls to the underlying Java object.
+ */ 
 class KStreamS[K, V](val inner: KStream[K, V]) {
 
   def filter(predicate: (K, V) => Boolean): KStreamS[K, V] = {

src/main/scala/com/lightbend/kafka/scala/streams/KTableS.scala

@@ -6,6 +6,9 @@ import org.apache.kafka.common.utils.Bytes
 import ImplicitConversions._
 import FunctionConversions._
 
+/**
+ * Wraps the Java class KTable and delegates method calls to the underlying Java object.
+ */ 
 class KTableS[K, V](val inner: KTable[K, V]) {
 
   def filter(predicate: (K, V) => Boolean): KTableS[K, V] = {

src/main/scala/com/lightbend/kafka/scala/streams/SessionWindowedKStreamS.scala

@@ -7,6 +7,9 @@ import FunctionConversions._
 
 import ImplicitConversions._
 
+/**
+ * Wraps the Java class SessionWindowedKStream and delegates method calls to the underlying Java object.
+ */ 
 class SessionWindowedKStreamS[K, V](val inner: SessionWindowedKStream[K, V]) {
 
   def aggregate[VR](initializer: () => VR,

src/main/scala/com/lightbend/kafka/scala/streams/StreamsBuilderS.scala

@@ -11,6 +11,9 @@ import org.apache.kafka.common.utils.Bytes
 
 import scala.collection.JavaConverters._
 
+/**
+ * Wraps the Java class StreamsBuilder and delegates method calls to the underlying Java object.
+ */ 
 class StreamsBuilderS {
 
   val inner = new StreamsBuilder

src/main/scala/com/lightbend/kafka/scala/streams/TimeWindowedKStreamS.scala

@@ -7,6 +7,9 @@ import org.apache.kafka.common.serialization.Serde
 import ImplicitConversions._
 import FunctionConversions._
 
+/**
+ * Wraps the Java class TimeWindowedKStream and delegates method calls to the underlying Java object.
+ */ 
 class TimeWindowedKStreamS[K, V](val inner: TimeWindowedKStream[K, V]) {
 
   def aggregate[VR](initializer: () => VR,