From 51c0f283e24d89c93c8ac3b755f8578906c8f8e5 Mon Sep 17 00:00:00 2001 From: Mike Hearn Date: Mon, 10 Feb 2014 13:14:48 +0100 Subject: [PATCH] PaymentSession: javadoc formatting. --- .../protocols/payments/PaymentSession.java | 21 +++++++++---------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/core/src/main/java/com/google/bitcoin/protocols/payments/PaymentSession.java b/core/src/main/java/com/google/bitcoin/protocols/payments/PaymentSession.java index 8e385afe2..b15ae38f1 100644 --- a/core/src/main/java/com/google/bitcoin/protocols/payments/PaymentSession.java +++ b/core/src/main/java/com/google/bitcoin/protocols/payments/PaymentSession.java @@ -56,20 +56,19 @@ import java.util.concurrent.Callable; *
  • Directly with a {@link Protos.PaymentRequest} object
  • * * - * If initialized with a BitcoinURI or a url, a network request is made for the payment request object and a - * ListenableFuture is returned that will be notified with the PaymentSession object after it is downloaded. + *

    If initialized with a BitcoinURI or a url, a network request is made for the payment request object and a + * ListenableFuture is returned that will be notified with the PaymentSession object after it is downloaded.

    * - * Once the PaymentSession is initialized, typically a wallet application will prompt the user to confirm that the + *

    Once the PaymentSession is initialized, typically a wallet application will prompt the user to confirm that the * amount and recipient are correct, perform any additional steps, and then construct a list of transactions to pass to - * the sendPayment method. + * the sendPayment method.

    * - * Call sendPayment with a list of transactions that will be broadcast. A {@link Protos.Payment} message will be sent to - * the merchant if a payment url is provided in the PaymentRequest. - * NOTE: sendPayment does NOT broadcast the transactions to the bitcoin network. - * - * sendPayment returns a ListenableFuture that will be notified when a {@link Protos.PaymentACK} is received from the - * merchant. Typically a wallet will show the message to the user as a confirmation message that the payment is now - * "processing" or that an error occurred. + *

    Call sendPayment with a list of transactions that will be broadcast. A {@link Protos.Payment} message will be sent + * to the merchant if a payment url is provided in the PaymentRequest. NOTE: sendPayment does NOT broadcast the + * transactions to the bitcoin network. Instead it returns a ListenableFuture that will be notified when a + * {@link Protos.PaymentACK} is received from the merchant. Typically a wallet will show the message to the user + * as a confirmation message that the payment is now "processing" or that an error occurred, and then broadcast the + * tx itself later if needed.

    * * @author Kevin Greene * @see BIP 0070