Merge pull request #1543 from stripe/richardm-regenerate-docstrings

Docstring formatting
stripe · Apr 6, 2023 · f074ad9 · f074ad9
2 parents 762cd6a + 5e85074
commit f074ad9
Show file tree

Hide file tree

Showing 174 changed files with 4,051 additions and 3,473 deletions.
diff --git a/src/main/java/com/stripe/model/BalanceTransaction.java b/src/main/java/com/stripe/model/BalanceTransaction.java
@@ -160,8 +160,8 @@ public void setSourceObject(BalanceTransactionSource expandableObject) {
    * charges, transfers, and so forth). The transactions are returned in sorted order, with the most
    * recent transactions appearing first.
    *
-   * <p>Note that this endpoint was previously called “Balance history” and used the path <code>
-   * /v1/balance/history</code>.
+   * <p>Note that this endpoint was previously called “Balance history” and used the path {@code
+   * /v1/balance/history}.
    */
   public static BalanceTransactionCollection list(Map<String, Object> params)
       throws StripeException {
@@ -173,8 +173,8 @@ public static BalanceTransactionCollection list(Map<String, Object> params)
    * charges, transfers, and so forth). The transactions are returned in sorted order, with the most
    * recent transactions appearing first.
    *
-   * <p>Note that this endpoint was previously called “Balance history” and used the path <code>
-   * /v1/balance/history</code>.
+   * <p>Note that this endpoint was previously called “Balance history” and used the path {@code
+   * /v1/balance/history}.
    */
   public static BalanceTransactionCollection list(
       Map<String, Object> params, RequestOptions options) throws StripeException {
@@ -187,8 +187,8 @@ public static BalanceTransactionCollection list(
    * charges, transfers, and so forth). The transactions are returned in sorted order, with the most
    * recent transactions appearing first.
    *
-   * <p>Note that this endpoint was previously called “Balance history” and used the path <code>
-   * /v1/balance/history</code>.
+   * <p>Note that this endpoint was previously called “Balance history” and used the path {@code
+   * /v1/balance/history}.
    */
   public static BalanceTransactionCollection list(BalanceTransactionListParams params)
       throws StripeException {
@@ -200,8 +200,8 @@ public static BalanceTransactionCollection list(BalanceTransactionListParams par
    * charges, transfers, and so forth). The transactions are returned in sorted order, with the most
    * recent transactions appearing first.
    *
-   * <p>Note that this endpoint was previously called “Balance history” and used the path <code>
-   * /v1/balance/history</code>.
+   * <p>Note that this endpoint was previously called “Balance history” and used the path {@code
+   * /v1/balance/history}.
    */
   public static BalanceTransactionCollection list(
       BalanceTransactionListParams params, RequestOptions options) throws StripeException {
@@ -212,7 +212,7 @@ public static BalanceTransactionCollection list(
   /**
    * Retrieves the balance transaction with the given ID.
    *
-   * <p>Note that this endpoint previously used the path <code>/v1/balance/history/:id</code>.
+   * <p>Note that this endpoint previously used the path {@code /v1/balance/history/:id}.
    */
   public static BalanceTransaction retrieve(String id) throws StripeException {
     return retrieve(id, (Map<String, Object>) null, (RequestOptions) null);
@@ -221,7 +221,7 @@ public static BalanceTransaction retrieve(String id) throws StripeException {
   /**
    * Retrieves the balance transaction with the given ID.
    *
-   * <p>Note that this endpoint previously used the path <code>/v1/balance/history/:id</code>.
+   * <p>Note that this endpoint previously used the path {@code /v1/balance/history/:id}.
    */
   public static BalanceTransaction retrieve(String id, RequestOptions options)
       throws StripeException {
@@ -231,7 +231,7 @@ public static BalanceTransaction retrieve(String id, RequestOptions options)
   /**
    * Retrieves the balance transaction with the given ID.
    *
-   * <p>Note that this endpoint previously used the path <code>/v1/balance/history/:id</code>.
+   * <p>Note that this endpoint previously used the path {@code /v1/balance/history/:id}.
    */
   public static BalanceTransaction retrieve(
       String id, Map<String, Object> params, RequestOptions options) throws StripeException {
@@ -247,7 +247,7 @@ public static BalanceTransaction retrieve(
   /**
    * Retrieves the balance transaction with the given ID.
    *
-   * <p>Note that this endpoint previously used the path <code>/v1/balance/history/:id</code>.
+   * <p>Note that this endpoint previously used the path {@code /v1/balance/history/:id}.
    */
   public static BalanceTransaction retrieve(
       String id, BalanceTransactionRetrieveParams params, RequestOptions options)

diff --git a/src/main/java/com/stripe/model/Charge.java b/src/main/java/com/stripe/model/Charge.java
@@ -701,20 +701,20 @@ public Charge capture(ChargeCaptureParams params, RequestOptions options) throws
   }
 
   /**
-   * To charge a credit card or other payment source, you create a <code>Charge</code> object. If
-   * your API key is in test mode, the supplied payment source (e.g., card) won’t actually be
-   * charged, although everything else will occur as if in live mode. (Stripe assumes that the
-   * charge would have completed successfully).
+   * To charge a credit card or other payment source, you create a {@code Charge} object. If your
+   * API key is in test mode, the supplied payment source (e.g., card) won’t actually be charged,
+   * although everything else will occur as if in live mode. (Stripe assumes that the charge would
+   * have completed successfully).
    */
   public static Charge create(Map<String, Object> params) throws StripeException {
     return create(params, (RequestOptions) null);
   }
 
   /**
-   * To charge a credit card or other payment source, you create a <code>Charge</code> object. If
-   * your API key is in test mode, the supplied payment source (e.g., card) won’t actually be
-   * charged, although everything else will occur as if in live mode. (Stripe assumes that the
-   * charge would have completed successfully).
+   * To charge a credit card or other payment source, you create a {@code Charge} object. If your
+   * API key is in test mode, the supplied payment source (e.g., card) won’t actually be charged,
+   * although everything else will occur as if in live mode. (Stripe assumes that the charge would
+   * have completed successfully).
    */
   public static Charge create(Map<String, Object> params, RequestOptions options)
       throws StripeException {
@@ -723,20 +723,20 @@ public static Charge create(Map<String, Object> params, RequestOptions options)
   }
 
   /**
-   * To charge a credit card or other payment source, you create a <code>Charge</code> object. If
-   * your API key is in test mode, the supplied payment source (e.g., card) won’t actually be
-   * charged, although everything else will occur as if in live mode. (Stripe assumes that the
-   * charge would have completed successfully).
+   * To charge a credit card or other payment source, you create a {@code Charge} object. If your
+   * API key is in test mode, the supplied payment source (e.g., card) won’t actually be charged,
+   * although everything else will occur as if in live mode. (Stripe assumes that the charge would
+   * have completed successfully).
    */
   public static Charge create(ChargeCreateParams params) throws StripeException {
     return create(params, (RequestOptions) null);
   }
 
   /**
-   * To charge a credit card or other payment source, you create a <code>Charge</code> object. If
-   * your API key is in test mode, the supplied payment source (e.g., card) won’t actually be
-   * charged, although everything else will occur as if in live mode. (Stripe assumes that the
-   * charge would have completed successfully).
+   * To charge a credit card or other payment source, you create a {@code Charge} object. If your
+   * API key is in test mode, the supplied payment source (e.g., card) won’t actually be charged,
+   * although everything else will occur as if in live mode. (Stripe assumes that the charge would
+   * have completed successfully).
    */
   public static Charge create(ChargeCreateParams params, RequestOptions options)
       throws StripeException {

diff --git a/src/main/java/com/stripe/model/Coupon.java b/src/main/java/com/stripe/model/Coupon.java
@@ -146,12 +146,11 @@ public class Coupon extends ApiResource implements HasId, MetadataStore<Coupon>
    * management</a> page of the Stripe dashboard. Coupon creation is also accessible via the API if
    * you need to create coupons on the fly.
    *
-   * <p>A coupon has either a <code>percent_off</code> or an <code>amount_off</code> and <code>
-   * currency</code>. If you set an <code>amount_off</code>, that amount will be subtracted from any
-   * invoice’s subtotal. For example, an invoice with a subtotal of 100 will have a final total of 0
-   * if a coupon with an <code>amount_off</code> of 200 is applied to it and an invoice with a
-   * subtotal of 300 will have a final total of 100 if a coupon with an <code>amount_off</code> of
-   * 200 is applied to it.
+   * <p>A coupon has either a {@code percent_off} or an {@code amount_off} and {@code currency}. If
+   * you set an {@code amount_off}, that amount will be subtracted from any invoice’s subtotal. For
+   * example, an invoice with a subtotal of 100 will have a final total of 0 if a coupon with an
+   * {@code amount_off} of 200 is applied to it and an invoice with a subtotal of 300 will have a
+   * final total of 100 if a coupon with an {@code amount_off} of 200 is applied to it.
    */
   public static Coupon create(Map<String, Object> params) throws StripeException {
     return create(params, (RequestOptions) null);
@@ -162,12 +161,11 @@ public static Coupon create(Map<String, Object> params) throws StripeException {
    * management</a> page of the Stripe dashboard. Coupon creation is also accessible via the API if
    * you need to create coupons on the fly.
    *
-   * <p>A coupon has either a <code>percent_off</code> or an <code>amount_off</code> and <code>
-   * currency</code>. If you set an <code>amount_off</code>, that amount will be subtracted from any
-   * invoice’s subtotal. For example, an invoice with a subtotal of 100 will have a final total of 0
-   * if a coupon with an <code>amount_off</code> of 200 is applied to it and an invoice with a
-   * subtotal of 300 will have a final total of 100 if a coupon with an <code>amount_off</code> of
-   * 200 is applied to it.
+   * <p>A coupon has either a {@code percent_off} or an {@code amount_off} and {@code currency}. If
+   * you set an {@code amount_off}, that amount will be subtracted from any invoice’s subtotal. For
+   * example, an invoice with a subtotal of 100 will have a final total of 0 if a coupon with an
+   * {@code amount_off} of 200 is applied to it and an invoice with a subtotal of 300 will have a
+   * final total of 100 if a coupon with an {@code amount_off} of 200 is applied to it.
    */
   public static Coupon create(Map<String, Object> params, RequestOptions options)
       throws StripeException {
@@ -180,12 +178,11 @@ public static Coupon create(Map<String, Object> params, RequestOptions options)
    * management</a> page of the Stripe dashboard. Coupon creation is also accessible via the API if
    * you need to create coupons on the fly.
    *
-   * <p>A coupon has either a <code>percent_off</code> or an <code>amount_off</code> and <code>
-   * currency</code>. If you set an <code>amount_off</code>, that amount will be subtracted from any
-   * invoice’s subtotal. For example, an invoice with a subtotal of 100 will have a final total of 0
-   * if a coupon with an <code>amount_off</code> of 200 is applied to it and an invoice with a
-   * subtotal of 300 will have a final total of 100 if a coupon with an <code>amount_off</code> of
-   * 200 is applied to it.
+   * <p>A coupon has either a {@code percent_off} or an {@code amount_off} and {@code currency}. If
+   * you set an {@code amount_off}, that amount will be subtracted from any invoice’s subtotal. For
+   * example, an invoice with a subtotal of 100 will have a final total of 0 if a coupon with an
+   * {@code amount_off} of 200 is applied to it and an invoice with a subtotal of 300 will have a
+   * final total of 100 if a coupon with an {@code amount_off} of 200 is applied to it.
    */
   public static Coupon create(CouponCreateParams params) throws StripeException {
     return create(params, (RequestOptions) null);
@@ -196,12 +193,11 @@ public static Coupon create(CouponCreateParams params) throws StripeException {
    * management</a> page of the Stripe dashboard. Coupon creation is also accessible via the API if
    * you need to create coupons on the fly.
    *
-   * <p>A coupon has either a <code>percent_off</code> or an <code>amount_off</code> and <code>
-   * currency</code>. If you set an <code>amount_off</code>, that amount will be subtracted from any
-   * invoice’s subtotal. For example, an invoice with a subtotal of 100 will have a final total of 0
-   * if a coupon with an <code>amount_off</code> of 200 is applied to it and an invoice with a
-   * subtotal of 300 will have a final total of 100 if a coupon with an <code>amount_off</code> of
-   * 200 is applied to it.
+   * <p>A coupon has either a {@code percent_off} or an {@code amount_off} and {@code currency}. If
+   * you set an {@code amount_off}, that amount will be subtracted from any invoice’s subtotal. For
+   * example, an invoice with a subtotal of 100 will have a final total of 0 if a coupon with an
+   * {@code amount_off} of 200 is applied to it and an invoice with a subtotal of 300 will have a
+   * final total of 100 if a coupon with an {@code amount_off} of 200 is applied to it.
    */
   public static Coupon create(CouponCreateParams params, RequestOptions options)
       throws StripeException {