Merge pull request #61 from reactive-streams/edit-doc-simplified-types

Prepare for 0.4.0.M1

Author: smaldini

Diff for: CopyrightWaivers.txt

@@ -21,3 +21,4 @@ github name    | Real Name, Email Address used for git commits, Company
 rkuhn          | Roland Kuhn, [email protected], Typesafe Inc.
 benjchristensen| Ben Christensen, [email protected], Netflix Inc.
 viktorklang    | Viktor Klang, [email protected], Typesafe Inc.
+smaldini       | Stephane Maldini, [email protected], Pivotal Software Inc.

Diff for: README.md

@@ -1,4 +1,4 @@
-name := "reactive-streams-api"
+name := "reactive-streams"
 
 javacOptions in compile ++= Seq("-encoding", "UTF-8", "-source", "1.6", "-target", "1.6", "-Xlint:unchecked", "-Xlint:deprecation")
 

Diff for: api/build.sbt

@@ -14,7 +14,7 @@ public interface Publisher<T> {
      * If the {@link Publisher} rejects the subscription attempt or otherwise fails it will 
      * signal the error via {@link Subscriber#onError}.
      * 
-     * @param s
+     * @param s the {@link Subscriber} that will consume signals from this {@link Publisher}
      */
     public void subscribe(Subscriber<T> s);
 }

Diff for: api/src/main/java/org/reactivestreams/Publisher.java

@@ -8,12 +8,12 @@
  * After signaling demand:
  * <ul>
  * <li>One or more invocations of {@link #onNext(Object)} up to the maximum number defined by {@link Subscription#request(int)}</li>
- * <li>Single invocation of {@link #onError(Throwable)} or {@link #onCompleted()} which signals a terminal state after which no further events will be sent.
+ * <li>Single invocation of {@link #onError(Throwable)} or {@link Subscriber#onComplete()} which signals a terminal state after which no further events will be sent.
  * </ul>
  * <p>
- * Demand can be signalled via {@link Subscription#request(int)} whenever the {@link Subscriber} instance is capable of handling more.
+ * Demand can be signaled via {@link Subscription#request(int)} whenever the {@link Subscriber} instance is capable of handling more.
  *
- * @param <T>
+ * @param <T> the Type of element signaled.
  */
 public interface Subscriber<T> {
     /**
@@ -33,16 +33,16 @@ public interface Subscriber<T> {
     /**
      * Data notification sent by the {@link Publisher} in response to requests to {@link Subscription#request(int)}.
      * 
-     * @param t
+     * @param t the element signaled
      */
     public void onNext(T t);
 
     /**
      * Failed terminal state.
      * <p>
      * No further events will be sent even if {@link Subscription#request(int)} is invoked again.
-     * 
-     * @param t
+     *
+     * @param t the throwable signaled
      */
     public void onError(Throwable t);
 

Diff for: api/src/main/java/org/reactivestreams/Subscriber.java

@@ -19,7 +19,7 @@ public interface Subscription {
      * A {@link Publisher} can send less than is requested if the stream ends but
      * then must emit either {@link Subscriber#onError(Throwable)} or {@link Subscriber#onComplete()}.
      * 
-     * @param n
+     * @param n the strictly positive number of elements to requests to the upstream {@link Publisher}
      */
     public void request(int n);
 

Diff for: api/src/main/java/org/reactivestreams/Subscription.java

@@ -1,6 +1,6 @@
 organization in ThisBuild := "org.reactivestreams"
 
-version in ThisBuild := "0.4-SNAPSHOT"
+version in ThisBuild := "0.4.0.M1"
 
 scalaVersion in ThisBuild := "2.10.3"