Minor: javadoc fixes

This commit is contained in:
Mike Hearn 2016-01-22 18:30:07 +01:00 committed by Mike Hearn
parent b014782959
commit a355ad14be
2 changed files with 5 additions and 6 deletions

View File

@ -40,11 +40,10 @@ import java.time.Instant
* *
* Note that it's the *seller* who initiates contact with the buyer, not vice-versa as you might imagine. * Note that it's the *seller* who initiates contact with the buyer, not vice-versa as you might imagine.
* *
* To get an implementation of this class, use the static [TwoPartyTradeProtocol.create] method. Then use either * To initiate the protocol, use either the [runBuyer] or [runSeller] methods, depending on which side of the trade
* the [runBuyer] or [runSeller] methods, depending on which side of the trade your node is taking. These methods * your node is taking. These methods return a future which will complete once the trade is over and a fully signed
* return a future which will complete once the trade is over and a fully signed transaction is available: you can * transaction is available: you can either block your thread waiting for the protocol to complete by using
* either block your thread waiting for the protocol to complete by using [ListenableFuture.get] or more usefully, * [ListenableFuture.get] or more usefully, register a callback that will be invoked when the time comes.
* register a callback that will be invoked when the time comes.
* *
* To see an example of how to use this class, look at the unit tests. * To see an example of how to use this class, look at the unit tests.
*/ */

View File

@ -42,7 +42,7 @@ import javax.annotation.concurrent.ThreadSafe
* (bad for performance, good for programmer mental health!). * (bad for performance, good for programmer mental health!).
* *
* A "state machine" is a class with a single call method. The call method and any others it invokes are rewritten by * A "state machine" is a class with a single call method. The call method and any others it invokes are rewritten by
* a bytecode rewriting engine called JavaFlow, to ensure the code can be suspended and resumed at any point. * a bytecode rewriting engine called Quasar, to ensure the code can be suspended and resumed at any point.
* *
* TODO: The framework should propagate exceptions and handle error handling automatically. * TODO: The framework should propagate exceptions and handle error handling automatically.
* TODO: Session IDs should be set up and propagated automatically, on demand. * TODO: Session IDs should be set up and propagated automatically, on demand.