Skip to content

Commit

Permalink
Update javadoc
Browse files Browse the repository at this point in the history
  • Loading branch information
ct-sdks[bot] committed Jan 22, 2025
1 parent 7ee059b commit b83d356
Show file tree
Hide file tree
Showing 17 changed files with 239 additions and 86 deletions.
2 changes: 1 addition & 1 deletion javadoc/allclasses-index.html
Original file line number Diff line number Diff line change
Expand Up @@ -13403,7 +13403,7 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">&nbsp;</div>
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/commercetools/docs/meta/ClientTuning.html" title="class in com.commercetools.docs.meta">ClientTuning</a></div>
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
<div class="block"><b>Table of content</b><ul><li><a href="#client-tuning">Tuning the client</a></li><ul><li><a href="#blocking-execution">Blocking execution</a></li><li><a href="#policy-middleware">PolicyMiddleware</a></li><li><a href="#configure-http-client">Configure the underlying http client</a></li><li><a href="#limit-requests">Limit concurrent requests</a></li><li><a href="#timeouts">Timeouts</a></li></ul></ul></div>
<div class="block"><b>Table of content</b><ul><li><a href="#client-tuning">Tuning the client</a></li><ul><li><a href="#blocking-execution">Blocking execution</a></li><li><a href="#policy-middleware">PolicyMiddleware</a></li><li><a href="#configure-http-client">Configure the underlying http client</a></li><li><a href="#limit-requests">Limit concurrent requests</a></li><li><a href="#timeouts">Timeouts</a></li><li><a href="#http-version">HTTP protocol version</a></li></ul></ul></div>
</div>
<div class="col-first odd-row-color all-classes-table all-classes-table-tab2"><a href="io/vrap/rmf/base/client/utils/ClientUtils.html" title="class in io.vrap.rmf.base.client.utils">ClientUtils</a></div>
<div class="col-last odd-row-color all-classes-table all-classes-table-tab2">&nbsp;</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -114,10 +114,10 @@ <h2>Method Summary</h2>
<div class="col-last even-row-color method-summary-table method-summary-table-tab1">
<div class="block">factory method to create a deep copy of DiscountedTotalPricePortion</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@NotNull @Valid <a href="../cart_discount/CartDiscountReference.html" title="interface in com.commercetools.api.models.cart_discount">CartDiscountReference</a></code></div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@NotNull @Valid <a href="../common/Reference.html" title="interface in com.commercetools.api.models.common">Reference</a></code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getDiscount()" class="member-name-link">getDiscount</a>()</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Cart Discount related to the discounted price.</div>
<div class="block">A CartDiscountReference or DirectDiscountReference to the discount applied on the Cart <code>totalPrice</code>.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@NotNull @Valid <a href="../common/TypedMoney.html" title="interface in com.commercetools.api.models.common">TypedMoney</a></code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getDiscountedAmount()" class="member-name-link">getDiscountedAmount</a>()</code></div>
Expand All @@ -135,9 +135,9 @@ <h2>Method Summary</h2>
<div class="block">factory method to create a shallow copy DiscountedTotalPricePortion</div>
</div>
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setDiscount(com.commercetools.api.models.cart_discount.CartDiscountReference)" class="member-name-link">setDiscount</a><wbr>(<a href="../cart_discount/CartDiscountReference.html" title="interface in com.commercetools.api.models.cart_discount">CartDiscountReference</a>&nbsp;discount)</code></div>
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setDiscount(com.commercetools.api.models.common.Reference)" class="member-name-link">setDiscount</a><wbr>(<a href="../common/Reference.html" title="interface in com.commercetools.api.models.common">Reference</a>&nbsp;discount)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
<div class="block">Cart Discount related to the discounted price.</div>
<div class="block">A CartDiscountReference or DirectDiscountReference to the discount applied on the Cart <code>totalPrice</code>.</div>
</div>
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setDiscountedAmount(com.commercetools.api.models.common.TypedMoney)" class="member-name-link">setDiscountedAmount</a><wbr>(<a href="../common/TypedMoney.html" title="interface in com.commercetools.api.models.common">TypedMoney</a>&nbsp;discountedAmount)</code></div>
Expand Down Expand Up @@ -173,8 +173,8 @@ <h2>Method Details</h2>
<h3>getDiscount</h3>
<div class="member-signature"><span class="annotations">@NotNull
@Valid
</span><span class="return-type">@NotNull @Valid <a href="../cart_discount/CartDiscountReference.html" title="interface in com.commercetools.api.models.cart_discount">CartDiscountReference</a></span>&nbsp;<span class="element-name">getDiscount</span>()</div>
<div class="block"><p>Cart Discount related to the discounted price.</p></div>
</span><span class="return-type">@NotNull @Valid <a href="../common/Reference.html" title="interface in com.commercetools.api.models.common">Reference</a></span>&nbsp;<span class="element-name">getDiscount</span>()</div>
<div class="block"><p>A CartDiscountReference or DirectDiscountReference to the discount applied on the Cart <code>totalPrice</code>.</p></div>
<dl class="notes">
<dt>Returns:</dt>
<dd>discount</dd>
Expand All @@ -195,10 +195,10 @@ <h3>getDiscountedAmount</h3>
</section>
</li>
<li>
<section class="detail" id="setDiscount(com.commercetools.api.models.cart_discount.CartDiscountReference)">
<section class="detail" id="setDiscount(com.commercetools.api.models.common.Reference)">
<h3>setDiscount</h3>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">setDiscount</span><wbr><span class="parameters">(<a href="../cart_discount/CartDiscountReference.html" title="interface in com.commercetools.api.models.cart_discount">CartDiscountReference</a>&nbsp;discount)</span></div>
<div class="block"><p>Cart Discount related to the discounted price.</p></div>
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">setDiscount</span><wbr><span class="parameters">(<a href="../common/Reference.html" title="interface in com.commercetools.api.models.common">Reference</a>&nbsp;discount)</span></div>
<div class="block"><p>A CartDiscountReference or DirectDiscountReference to the discount applied on the Cart <code>totalPrice</code>.</p></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>discount</code> - value to be set</dd>
Expand Down
Loading

0 comments on commit b83d356

Please sign in to comment.