add javadoc

jdegoes · Nov 10, 2010 · 9d9bb3f · 9d9bb3f
1 parent ca17b90
commit 9d9bb3f
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 0 deletions.
diff --git a/src/main/scala/blueeyes/BlueEyesServer.scala b/src/main/scala/blueeyes/BlueEyesServer.scala
@@ -5,6 +5,19 @@ import blueeyes.core.service._
 import blueeyes.core.service.engines._
 import blueeyes.util.{Future, FutureImplicits}
 
+/** Convenience trait for building a server. This server uses reflection to mix
+ * in any services defined as fields.
+ * <pre>
+ * trait EmailServices extends BlueEyesServiceBuilder {
+ *   val emailService = service("email", "1.32") {
+ *     request {
+ *       ...
+ *     }
+ *   }
+ * }
+ * object EmailServer extends BlueEyesServer with EmailService
+ * </pre>
+ */
 trait BlueEyesServer extends HttpServer[Array[Byte]] with HttpReflectiveServiceList[Array[Byte]] with NettyEngineArrayByte {
 
 }
diff --git a/src/main/scala/blueeyes/BlueEyesServiceBuilder.scala b/src/main/scala/blueeyes/BlueEyesServiceBuilder.scala
@@ -5,6 +5,16 @@ import blueeyes.core.service._
 import blueeyes.util.{Future, FutureImplicits}
 
 /** Convenience trait for building services with many common mixins. 
+ * <pre>
+ * trait EmailServices extends BlueEyesServiceBuilder {
+ *   val emailService = service("email", "1.32") {
+ *     request {
+ *       ...
+ *     }
+ *   }
+ * }
+ * object EmailServer extends BlueEyesServer with EmailService
+ * </pre>
  */
 trait BlueEyesServiceBuilder[T] extends HttpServiceBuilder[T] with 
   FutureImplicits with