Fix spockframework#1018 wrong java doc (spockframework#1045)

Add missing it to the property name examples for mocking and
rirl · Dec 31, 2019 · 9d56b96 · 9d56b96
1 parent e2ff629
commit 9d56b96
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 35 deletions.
diff --git a/spock-core/src/main/java/spock/mock/MockingApi.java b/spock-core/src/main/java/spock/mock/MockingApi.java
@@ -239,7 +239,7 @@ public <T> T Mock(
    * <pre>
    *   // type is Person.class, name is "person", returns hard-coded value for {@code name}, expects one call to {@code sing()}
    *   Person person = Mock {
-   *     name << "Fred"
+   *     it.name >> "Fred"
    *     1 * sing()
    *   }
    * </pre>
@@ -264,7 +264,7 @@ public <T> T Mock(Closure interactions) {
    * <pre>
    *   // type is Person.class, name is "myPerson", returns hard-coded value for {@code name}, expects one call to {@code sing()}
    *   Person person = Mock(name: "myPerson") {
-   *     name << "Fred"
+   *     it.name >> "Fred"
    *     1 * sing()
    *   }
    * </pre>
@@ -290,7 +290,7 @@ public <T> T Mock(Map<String, Object> options, Closure interactions) {
    * <pre>
    *   // name is "person", type is Person.class, returns hard-code value {@code name}, expects one call to {@code sing()}
    *   def person = Mock(Person) {
-   *     name << "Fred"
+   *     it.name >> "Fred"
    *     1 * sing()
    *   }
    * </pre>
@@ -321,7 +321,7 @@ public <T> T Mock(
    * <pre>
    *   // type is Person.class, name is "myPerson", returns hard-coded value {@code name}, expects one call to {@code sing()}
    *   def person = Mock(Person, name: "myPerson") {
-   *     name << "Fred"
+   *     it.name >> "Fred"
    *     1 * sing()
    *   }
    * </pre>
@@ -460,8 +460,8 @@ public <T> T Stub(
    * <pre>
    *   // type is Person.class, name is "person", returns hard-coded values for property {@code name} and method {@code sing()}
    *   Person person = Stub {
-   *     name << "Fred"
-   *     sing() << "Tra-la-la"
+   *     it.name >> "Fred"
+   *     sing() >> "Tra-la-la"
    *   }
    * </pre>
    *
@@ -485,8 +485,8 @@ public <T> T Stub(Closure interactions) {
    * <pre>
    *   // type is Person.class, name is "myPerson", returns hard-coded values for property {@code name} and method {@code sing()}
    *   Person person = Stub(name: "myPerson") {
-   *     name << "Fred"
-   *     sing() << "Tra-la-la"
+   *     it.name >> "Fred"
+   *     sing() >> "Tra-la-la"
    *   }
    * </pre>
    *
@@ -519,8 +519,8 @@ public <T> T Stub(
    * <pre>
    *   // name is "person", type is Person.class, returns hard-coded values for property {@code name} and method {@code sing()}
    *   def person = Stub(Person) {
-   *     name << "Fred"
-   *     sing() << "Tra-la-la"
+   *     it.name >> "Fred"
+   *     sing() >> "Tra-la-la"
    *   }
    * </pre>
    *
@@ -550,8 +550,8 @@ public <T> T Stub(
    * <pre>
    *   // type is Person.class, name is "myPerson", returns hard-coded values for property {@code name} and method {@code sing()}
    *   def person = Stub(Person, name: "myPerson") {
-   *     name << "Fred"
-   *     sing() << "Tra-la-la"
+   *     it.name >> "Fred"
+   *     sing() >> "Tra-la-la"
    *   }
    * </pre>
    *
@@ -715,7 +715,7 @@ public <T> T Spy(
    * <pre>
    *   // type is Person.class, name is "person", returns hard-coded value for {@code name}, calls real method otherwise
    *   Person person = Spy {
-   *     name << "Fred"
+   *     it.name >> "Fred"
    *   }
    * </pre>
    *
@@ -739,7 +739,7 @@ public <T> T Spy(Closure interactions) {
    * <pre>
    *   // type is Person.class, name is "myPerson", returns hard-coded value for {@code name}, calls real method otherwise
    *   Person person = Spy(name: "myPerson") {
-   *     name << "Fred"
+   *     it.name >> "Fred"
    *   }
    * </pre>
    *
@@ -772,7 +772,7 @@ public <T> T Spy(
    * <pre>
    *   // name is "person", type is Person.class, returns hard-code value {@code name}, calls real method otherwise
    *   def person = Spy(Person) {
-   *     name << "Fred"
+   *     it.name >> "Fred"
    *     1 * sing()
    *   }
    * </pre>
@@ -803,7 +803,7 @@ public <T> T Spy(
    * <pre>
    *   // type is Person.class, name is "myPerson", returns hard-coded value {@code name}, calls real method otherwise
    *   def person = Spy(Person, name: "myPerson") {
-   *     name << "Fred"
+   *     it.name >> "Fred"
    *   }
    * </pre>
    *
@@ -941,7 +941,7 @@ public <T> T GroovyMock(
    * <pre>
    *   // type is Person.class, name is "person", returns hard-coded value for {@code name}, expects one call to {@code sing()}
    *   Person person = GroovyMock {
-   *     name << "Fred"
+   *     it.name >> "Fred"
    *     1 * sing()
    *   }
    * </pre>
@@ -966,7 +966,7 @@ public <T> T GroovyMock(Closure interactions) {
    * <pre>
    *   // type is Person.class, name is "myPerson", returns hard-coded value for {@code name}, expects one call to {@code sing()}
    *   Person person = GroovyMock(name: "myPerson") {
-   *     name << "Fred"
+   *     it.name >> "Fred"
    *     1 * sing()
    *   }
    * </pre>
@@ -1001,7 +1001,7 @@ public <T> T GroovyMock(
    * <pre>
    *   // name is "person", type is Person.class, returns hard-code value {@code name}, expects one call to {@code sing()}
    *   def person = GroovyMock(Person) {
-   *     name << "Fred"
+   *     it.name >> "Fred"
    *     1 * sing()
    *   }
    * </pre>
@@ -1032,7 +1032,7 @@ public <T> T GroovyMock(
    * <pre>
    *   // type is Person.class, name is "myPerson", returns hard-coded value {@code name}, expects one call to {@code sing()}
    *   def person = GroovyMock(Person, name: "myPerson") {
-   *     name << "Fred"
+   *     it.name >> "Fred"
    *     1 * sing()
    *   }
    * </pre>
@@ -1172,8 +1172,8 @@ public <T> T GroovyStub(
    * <pre>
    *   // type is Person.class, name is "person", returns hard-coded values for property {@code name} and method {@code sing()}
    *   Person person = GroovyStub {
-   *     name << "Fred"
-   *     sing() << "Tra-la-la"
+   *     it.name >> "Fred"
+   *     sing() >> "Tra-la-la"
    *   }
    * </pre>
    *
@@ -1197,8 +1197,8 @@ public <T> T GroovyStub(Closure interactions) {
    * <pre>
    *   // type is Person.class, name is "myPerson", returns hard-coded values for property {@code name} and method {@code sing()}
    *   Person person = GroovyStub(name: "myPerson") {
-   *     name << "Fred"
-   *     sing() << "Tra-la-la"
+   *     it.name >> "Fred"
+   *     sing() >> "Tra-la-la"
    *   }
    * </pre>
    *
@@ -1232,8 +1232,8 @@ public <T> T GroovyStub(
    * <pre>
    *   // name is "person", type is Person.class, returns hard-coded values for property {@code name} and method {@code sing()}
    *   def person = GroovyStub(Person) {
-   *     name << "Fred"
-   *     sing() << "Tra-la-la"
+   *     it.name >> "Fred"
+   *     sing() >> "Tra-la-la"
    *   }
    * </pre>
    *
@@ -1263,8 +1263,8 @@ public <T> T GroovyStub(
    * <pre>
    *   // type is Person.class, name is "myPerson", returns hard-coded values for property {@code name} and method {@code sing()}
    *   def person = GroovyStub(Person, name: "myPerson") {
-   *     name << "Fred"
-   *     sing() << "Tra-la-la"
+   *     it.name >> "Fred"
+   *     sing() >> "Tra-la-la"
    *   }
    * </pre>
    *
@@ -1403,7 +1403,7 @@ public <T> T GroovySpy(
    * <pre>
    *   // type is Person.class, name is "person", returns hard-coded value for {@code name}, calls real method otherwise
    *   Person person = GroovySpy {
-   *     name << "Fred"
+   *     it.name >> "Fred"
    *   }
    * </pre>
    *
@@ -1427,7 +1427,7 @@ public <T> T GroovySpy(Closure interactions) {
    * <pre>
    *   // type is Person.class, name is "myPerson", returns hard-coded value for {@code name}, calls real method otherwise
    *   Person person = GroovySpy(name: "myPerson") {
-   *     name << "Fred"
+   *     it.name >> "Fred"
    *   }
    * </pre>
    *
@@ -1461,7 +1461,7 @@ public <T> T GroovySpy(
    * <pre>
    *   // name is "person", type is Person.class, returns hard-code value {@code name}, calls real method otherwise
    *   def person = GroovySpy(Person) {
-   *     name << "Fred"
+   *     it.name >> "Fred"
    *     1 * sing()
    *   }
    * </pre>
@@ -1492,7 +1492,7 @@ public <T> T GroovySpy(
    * <pre>
    *   // type is Person.class, name is "myPerson", returns hard-coded value {@code name}, calls real method otherwise
    *   def person = GroovySpy(Person, name: "myPerson") {
-   *     name << "Fred"
+   *     it.name >> "Fred"
    *   }
    * </pre>
    *

diff --git a/spock-core/src/main/java/spock/util/concurrent/AsyncConditions.java b/spock-core/src/main/java/spock/util/concurrent/AsyncConditions.java
@@ -38,7 +38,7 @@
  * def conds = new AsyncConditions()
  *
  * // register async callback
- * machine.workDone << { result ->
+ * machine.workDone >> { result ->
  *   conds.evaluate {
  *     assert result == WorkResult.OK
  *     // could add more explicit conditions here

diff --git a/spock-core/src/main/java/spock/util/concurrent/BlockingVariable.java b/spock-core/src/main/java/spock/util/concurrent/BlockingVariable.java
@@ -35,7 +35,7 @@
  * def result = new BlockingVariable&lt;WorkResult&gt;
  *
  * // register async callback
- * machine.workDone << { r ->
+ * machine.workDone >> { r ->
  *  result.set(r)
  * }
  *
@@ -124,4 +124,4 @@ public void set(T value) {
     this.value = value;
     valueReady.countDown();
   }
-}
+}