doc: Make the docs more robust with examples (#2226)

* doc: Make the docs more robust with examples
This commit is contained in:
justinr1234
2023-05-02 13:53:17 -07:00
committed by GitHub
parent 9131ab2515
commit 81f2233507
233 changed files with 8396 additions and 5109 deletions

View File

@@ -50,7 +50,7 @@ j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
</div></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">boolean</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/1a1d8087/packages/xrpl/src/utils/verifyPaymentChannelClaim.ts#L17">packages/xrpl/src/utils/verifyPaymentChannelClaim.ts:17</a></li></ul></aside></li></ul></section></div>
<li>Defined in <a href="https://github.com/XRPLF/xrpl.js/blob/0f02e78d/packages/xrpl/src/utils/verifyPaymentChannelClaim.ts#L17">packages/xrpl/src/utils/verifyPaymentChannelClaim.ts:17</a></li></ul></aside></li></ul></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
@@ -135,8 +135,6 @@ j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
<li class="tsd-kind-interface"><a href="../interfaces/EscrowCancel.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Escrow<wbr/>Cancel</a></li>
<li class="tsd-kind-interface"><a href="../interfaces/EscrowCreate.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Escrow<wbr/>Create</a></li>
<li class="tsd-kind-interface"><a href="../interfaces/EscrowFinish.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Escrow<wbr/>Finish</a></li>
<li class="tsd-kind-interface"><a href="../interfaces/FederatorInfoRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Federator<wbr/>Info<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="../interfaces/FederatorInfoResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Federator<wbr/>Info<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="../interfaces/FeeRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Fee<wbr/>Request</a></li>
<li class="tsd-kind-interface"><a href="../interfaces/FeeResponse.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Fee<wbr/>Response</a></li>
<li class="tsd-kind-interface"><a href="../interfaces/GatewayBalancesRequest.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-256-path"></use><use href="#icon-256-text"></use></svg>Gateway<wbr/>Balances<wbr/>Request</a></li>
@@ -224,7 +222,6 @@ j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
<li class="tsd-kind-function tsd-is-external"><a href="classicAddressToXAddress.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>classic<wbr/>Address<wbr/>ToXAddress</a></li>
<li class="tsd-kind-function"><a href="convertHexToString.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>convert<wbr/>Hex<wbr/>To<wbr/>String</a></li>
<li class="tsd-kind-function"><a href="convertStringToHex.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>convert<wbr/>String<wbr/>To<wbr/>Hex</a></li>
<li class="tsd-kind-function"><a href="createCrossChainPayment.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>create<wbr/>Cross<wbr/>Chain<wbr/>Payment</a></li>
<li class="tsd-kind-function"><a href="decimalToQuality.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>decimal<wbr/>To<wbr/>Quality</a></li>
<li class="tsd-kind-function"><a href="decimalToTransferRate.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>decimal<wbr/>To<wbr/>Transfer<wbr/>Rate</a></li>
<li class="tsd-kind-function"><a href="decode.html" class="tsd-index-link"><svg class="tsd-kind-icon" width="24" height="24" viewBox="0 0 24 24"><use href="#icon-64-path"></use><use href="#icon-64-text"></use></svg>decode</a></li>