--- jsr166/src/jsr166y/Phaser.java 2009/07/27 20:57:44 1.23 +++ jsr166/src/jsr166y/Phaser.java 2009/07/27 21:41:53 1.24 @@ -32,18 +32,19 @@ import java.util.concurrent.locks.LockSu * zero, and advancing when all parties reach the barrier (wrapping * around to zero after reaching {@code Integer.MAX_VALUE}). * - *
  • Like a CyclicBarrier, a Phaser may be repeatedly awaited. - * Method {@code arriveAndAwaitAdvance} has effect analogous to - * {@code CyclicBarrier.await}. However, Phasers separate two - * aspects of coordination, that may also be invoked independently: + *
  • Like a {@code CyclicBarrier}, a Phaser may be repeatedly + * awaited. Method {@link #arriveAndAwaitAdvance} has effect + * analogous to {@link java.util.concurrent.CyclicBarrier#await + * CyclicBarrier.await}. However, phasers separate two aspects of + * coordination, that may also be invoked independently: * * @@ -51,19 +52,19 @@ import java.util.concurrent.locks.LockSu * *
  • Barrier actions, performed by the task triggering a phase * advance while others may be waiting, are arranged by overriding - * method {@code onAdvance}, that also controls termination. + * method {@link #onAdvance}, that also controls termination. * Overriding this method may be used to similar but more flexible - * effect as providing a barrier action to a CyclicBarrier. + * effect as providing a barrier action to a {@code CyclicBarrier}. * *
  • Phasers may enter a termination state in which all * actions immediately return without updating phaser state or waiting * for advance, and indicating (via a negative phase value) that * execution is complete. Termination is triggered by executing the * overridable {@code onAdvance} method that is invoked each time the - * barrier is about to be tripped. When a Phaser is controlling an + * barrier is about to be tripped. When a phaser is controlling an * action with a fixed number of iterations, it is often convenient to * override this method to cause termination when the current phase - * number reaches a threshold. Method {@code forceTermination} is also + * number reaches a threshold. Method {@link #forceTermination} is also * available to abruptly release waiting threads and allow them to * terminate. * @@ -75,7 +76,7 @@ import java.util.concurrent.locks.LockSu * *
  • By default, {@code awaitAdvance} continues to wait even if * the waiting thread is interrupted. And unlike the case in - * CyclicBarriers, exceptions encountered while tasks wait + * {@code CyclicBarrier}, exceptions encountered while tasks wait * interruptibly or with timeout do not change the state of the * barrier. If necessary, you can perform any associated recovery * within handlers of those exceptions, often after invoking @@ -87,10 +88,10 @@ import java.util.concurrent.locks.LockSu * *

    Sample usages: * - *

    A Phaser may be used instead of a {@code CountDownLatch} to control - * a one-shot action serving a variable number of parties. The typical - * idiom is for the method setting this up to first register, then - * start the actions, then deregister, as in: + *

    A {@code Phaser} may be used instead of a {@code CountDownLatch} + * to control a one-shot action serving a variable number of + * parties. The typical idiom is for the method setting this up to + * first register, then start the actions, then deregister, as in: * *

     {@code
      * void runTasks(List list) {
    @@ -139,9 +140,9 @@ import java.util.concurrent.locks.LockSu
      *   phaser.arriveAndDeregister(); // deregister self, don't wait
      * }}
    * - *

    To create a set of tasks using a tree of Phasers, + *

    To create a set of tasks using a tree of phasers, * you could use code of the following form, assuming a - * Task class with a constructor accepting a Phaser that + * Task class with a constructor accepting a phaser that * it registers for upon construction: *

     {@code
      * void build(Task[] actions, int lo, int hi, Phaser b) {
    @@ -249,7 +250,7 @@ public class Phaser {
         private final Phaser parent;
     
         /**
    -     * The root of Phaser tree. Equals this if not in a tree.  Used to
    +     * The root of phaser tree. Equals this if not in a tree.  Used to
          * support faster state push-down.
          */
         private final Phaser root;
    @@ -300,16 +301,16 @@ public class Phaser {
         }
     
         /**
    -     * Creates a new Phaser without any initially registered parties,
    +     * Creates a new phaser without any initially registered parties,
          * initial phase number 0, and no parent. Any thread using this
    -     * Phaser will need to first register for it.
    +     * phaser will need to first register for it.
          */
         public Phaser() {
             this(null);
         }
     
         /**
    -     * Creates a new Phaser with the given numbers of registered
    +     * Creates a new phaser with the given numbers of registered
          * unarrived parties, initial phase number 0, and no parent.
          *
          * @param parties the number of parties required to trip barrier
    @@ -321,7 +322,7 @@ public class Phaser {
         }
     
         /**
    -     * Creates a new Phaser with the given parent, without any
    +     * Creates a new phaser with the given parent, without any
          * initially registered parties. If parent is non-null this phaser
          * is registered with the parent and its initial phase number is
          * the same as that of parent phaser.
    @@ -341,7 +342,7 @@ public class Phaser {
         }
     
         /**
    -     * Creates a new Phaser with the given parent and numbers of
    +     * Creates a new phaser with the given parent and numbers of
          * registered unarrived parties. If parent is non-null, this phaser
          * is registered with the parent and its initial phase number is
          * the same as that of parent phaser.
    @@ -719,7 +720,7 @@ public class Phaser {
          * 

    You may override this method to perform an action with side * effects visible to participating tasks, but it is in general * only sensible to do so in designs where all parties register - * before any arrive, and all {@code awaitAdvance} at each phase. + * before any arrive, and all {@link #awaitAdvance} at each phase. * Otherwise, you cannot ensure lack of interference. In * particular, this method may be invoked more than once per * transition if other parties successfully register while the