Skip to content

Commit

Permalink
docs: update xref service since it's no longer supported :(
Browse files Browse the repository at this point in the history
  • Loading branch information
@jasonboukheir
jasonboukheir committed Oct 13, 2023
1 parent f3f3fcc commit e28e906
Show file tree
Hide file tree
Showing 510 changed files with 5,943 additions and 5,997 deletions.
3 changes: 0 additions & 3 deletions .docfx/docfx.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -131,9 +131,6 @@
],
"xref": [
"https://normanderwan.github.io/UnityXrefMaps/xrefmap.yml"
],
"xrefService": [
"https://xref.docs.microsoft.com/query?uid={uid}"
]
}
}
72 changes: 26 additions & 46 deletions ...rand.Unity.AssetStore/Assets/Algorand.Unity/Documentation/api/Algorand.Unity.Account.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2065,7 +2065,7 @@ <h5 class="parameters">Parameters</h5>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">String</a></td>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">privateKeyOrMnemonic</span></td>
<td><p>A string that is either an mnemonic or a private key.</p>
</td>
Expand Down Expand Up @@ -2100,7 +2100,7 @@ <h5 class="parameters">Parameters</h5>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">String</a></td>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">privateKeyOrMnemonic</span></td>
<td><p>A string that is either an mnemonic or a private key.</p>
</td>
Expand All @@ -2113,7 +2113,8 @@ <h3 id="properties">Properties

<a id="Algorand_Unity_Account_Address_" data-uid="Algorand.Unity.Account.Address*"></a>
<h4 id="Algorand_Unity_Account_Address" data-uid="Algorand.Unity.Account.Address">Address</h4>
<div class="markdown level1 summary"><p>Address of this account</p>
<div class="markdown level1 summary"><p>A insecure, local, in-memory account. This is useful for creating quick accounts for developer testing, and it
should not be used in production.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
Expand Down Expand Up @@ -2157,7 +2158,7 @@ <h5 class="propertyValue">Property Value</h5>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
Expand Down Expand Up @@ -2291,7 +2292,8 @@ <h5 class="typeParameters">Type Parameters</h5>

<a id="Algorand_Unity_Account_SignTxns_" data-uid="Algorand.Unity.Account.SignTxns*"></a>
<h4 id="Algorand_Unity_Account_SignTxns__1___0___Algorand_Unity_TxnIndices_" data-uid="Algorand.Unity.Account.SignTxns``1(``0[],Algorand.Unity.TxnIndices)">SignTxns&lt;T&gt;(T[], TxnIndices)</h4>
<div class="markdown level1 summary"><p>Sign a group of transactions.</p>
<div class="markdown level1 summary"><p>A insecure, local, in-memory account. This is useful for creating quick accounts for developer testing, and it
should not be used in production.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
Expand All @@ -2312,14 +2314,12 @@ <h5 class="parameters">Parameters</h5>
<tr>
<td>T[]</td>
<td><span class="parametername">txns</span></td>
<td><p>The transactions to sign.</p>
</td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Algorand.Unity.TxnIndices.html">TxnIndices</a></td>
<td><span class="parametername">txnsToSign</span></td>
<td><p>Indexes of the transactions this signer should sign.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
Expand All @@ -2334,8 +2334,7 @@ <h5 class="returns">Returns</h5>
<tbody>
<tr>
<td><a class="xref" href="Algorand.Unity.SignedTxn-1.html">SignedTxn</a>&lt;T&gt;[]</td>
<td><p>An array of transactions with signatures. If the transaction at a given index was not signed, that signed transaction will have no signature.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
Expand All @@ -2350,19 +2349,16 @@ <h5 class="typeParameters">Type Parameters</h5>
<tbody>
<tr>
<td><span class="parametername">T</span></td>
<td><p>The type of the transactions.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Algorand_Unity_Account_SignTxns__1___0___Algorand_Unity_TxnIndices__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>Each transaction is expected to have a valid group id already set.</p>
</div>


<a id="Algorand_Unity_Account_SignTxnsAsync_" data-uid="Algorand.Unity.Account.SignTxnsAsync*"></a>
<h4 id="Algorand_Unity_Account_SignTxnsAsync__1___0___Algorand_Unity_TxnIndices_CancellationToken_" data-uid="Algorand.Unity.Account.SignTxnsAsync``1(``0[],Algorand.Unity.TxnIndices,CancellationToken)">SignTxnsAsync&lt;T&gt;(T[], TxnIndices, CancellationToken)</h4>
<div class="markdown level1 summary"><p>Sign a group of transactions.</p>
<div class="markdown level1 summary"><p>A insecure, local, in-memory account. This is useful for creating quick accounts for developer testing, and it
should not be used in production.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
Expand All @@ -2383,20 +2379,17 @@ <h5 class="parameters">Parameters</h5>
<tr>
<td>T[]</td>
<td><span class="parametername">txns</span></td>
<td><p>The transactions to sign.</p>
</td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Algorand.Unity.TxnIndices.html">TxnIndices</a></td>
<td><span class="parametername">txnsToSign</span></td>
<td><p>Indexes of the transactions this signer should sign.</p>
</td>
<td></td>
</tr>
<tr>
<td><span class="xref">CancellationToken</span></td>
<td><span class="parametername">cancellationToken</span></td>
<td><p>Provide an optional cancellation token to interrupt signing.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
Expand All @@ -2411,8 +2404,7 @@ <h5 class="returns">Returns</h5>
<tbody>
<tr>
<td><span class="xref">UniTask</span>&lt;<a class="xref" href="Algorand.Unity.SignedTxn-1.html">SignedTxn</a>&lt;T&gt;[]&gt;</td>
<td><p>An array of transactions with signatures. If the transaction at a given index was not signed, that signed transaction will have no signature.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
Expand All @@ -2427,19 +2419,16 @@ <h5 class="typeParameters">Type Parameters</h5>
<tbody>
<tr>
<td><span class="parametername">T</span></td>
<td><p>The type of the transactions.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Algorand_Unity_Account_SignTxnsAsync__1___0___Algorand_Unity_TxnIndices_CancellationToken__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>Each transaction is expected to have a valid group id already set.</p>
</div>


<a id="Algorand_Unity_Account_SignTxnsAsync_" data-uid="Algorand.Unity.Account.SignTxnsAsync*"></a>
<h4 id="Algorand_Unity_Account_SignTxnsAsync__2___0___Algorand_Unity_TxnIndices___1_CancellationToken_" data-uid="Algorand.Unity.Account.SignTxnsAsync``2(``0[],Algorand.Unity.TxnIndices,``1,CancellationToken)">SignTxnsAsync&lt;T, TProgress&gt;(T[], TxnIndices, TProgress, CancellationToken)</h4>
<div class="markdown level1 summary"><p>Sign a group of transactions.</p>
<div class="markdown level1 summary"><p>A insecure, local, in-memory account. This is useful for creating quick accounts for developer testing, and it
should not be used in production.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="declaration">Declaration</h5>
Expand All @@ -2460,26 +2449,22 @@ <h5 class="parameters">Parameters</h5>
<tr>
<td>T[]</td>
<td><span class="parametername">txns</span></td>
<td><p>The transactions to sign.</p>
</td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Algorand.Unity.TxnIndices.html">TxnIndices</a></td>
<td><span class="parametername">txnsToSign</span></td>
<td><p>Indexes of the transactions this signer should sign.</p>
</td>
<td></td>
</tr>
<tr>
<td><span class="xref">TProgress</span></td>
<td><span class="parametername">progress</span></td>
<td><p>A progress token that can be used to periodically check the progress.</p>
</td>
<td></td>
</tr>
<tr>
<td><span class="xref">CancellationToken</span></td>
<td><span class="parametername">cancellationToken</span></td>
<td><p>Provide an optional cancellation token to interrupt signing.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
Expand All @@ -2494,8 +2479,7 @@ <h5 class="returns">Returns</h5>
<tbody>
<tr>
<td><span class="xref">UniTask</span>&lt;<a class="xref" href="Algorand.Unity.SignedTxn-1.html">SignedTxn</a>&lt;T&gt;[]&gt;</td>
<td><p>An array of transactions with signatures. If the transaction at a given index was not signed, that signed transaction will have no signature.</p>
</td>
<td></td>
</tr>
</tbody>
</table>
Expand All @@ -2510,18 +2494,14 @@ <h5 class="typeParameters">Type Parameters</h5>
<tbody>
<tr>
<td><span class="parametername">T</span></td>
<td><p>The type of the transactions.</p>
</td>
<td></td>
</tr>
<tr>
<td><span class="parametername">TProgress</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Algorand_Unity_Account_SignTxnsAsync__2___0___Algorand_Unity_TxnIndices___1_CancellationToken__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>Each transaction is expected to have a valid group id already set.</p>
</div>
<h3 id="implements">Implements</h3>
<div>
<a class="xref" href="Algorand.Unity.IAccountSigner.html">IAccountSigner</a>
Expand Down
8 changes: 4 additions & 4 deletions ...setStore/Assets/Algorand.Unity/Documentation/api/Algorand.Unity.AccountParticipation.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1949,7 +1949,7 @@ <h5 class="fieldValue">Field Value</h5>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.uint64">UInt64</a></td>
<td><span class="xref">System.UInt64</span></td>
<td></td>
</tr>
</tbody>
Expand All @@ -1974,7 +1974,7 @@ <h5 class="fieldValue">Field Value</h5>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.uint64">UInt64</a></td>
<td><span class="xref">System.UInt64</span></td>
<td></td>
</tr>
</tbody>
Expand All @@ -1999,7 +1999,7 @@ <h5 class="fieldValue">Field Value</h5>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.uint64">UInt64</a></td>
<td><span class="xref">System.UInt64</span></td>
<td></td>
</tr>
</tbody>
Expand Down Expand Up @@ -2069,7 +2069,7 @@ <h5 class="returns">Returns</h5>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
Expand Down
28 changes: 14 additions & 14 deletions ...y.AssetStore/Assets/Algorand.Unity/Documentation/api/Algorand.Unity.Address.CheckSum.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1922,7 +1922,7 @@ <h5 class="fieldValue">Field Value</h5>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">Int32</a></td>
<td><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
Expand Down Expand Up @@ -1950,7 +1950,7 @@ <h5 class="parameters">Parameters</h5>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">Int32</a></td>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">index</span></td>
<td></td>
</tr>
Expand All @@ -1966,7 +1966,7 @@ <h5 class="propertyValue">Property Value</h5>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.byte">Byte</a></td>
<td><span class="xref">System.Byte</span></td>
<td></td>
</tr>
</tbody>
Expand All @@ -1991,7 +1991,7 @@ <h5 class="propertyValue">Property Value</h5>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">Int32</a></td>
<td><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
Expand Down Expand Up @@ -2035,7 +2035,7 @@ <h5 class="returns">Returns</h5>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
Expand All @@ -2061,7 +2061,7 @@ <h5 class="parameters">Parameters</h5>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">Object</a></td>
<td><span class="xref">System.Object</span></td>
<td><span class="parametername">obj</span></td>
<td></td>
</tr>
Expand All @@ -2077,13 +2077,13 @@ <h5 class="returns">Returns</h5>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.valuetype.equals#system-valuetype-equals(system-object)">ValueType.Equals(Object)</a></div>
<div><span class="xref">System.ValueType.Equals(System.Object)</span></div>


<a id="Algorand_Unity_Address_CheckSum_GetHashCode_" data-uid="Algorand.Unity.Address.CheckSum.GetHashCode*"></a>
Expand All @@ -2104,13 +2104,13 @@ <h5 class="returns">Returns</h5>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">Int32</a></td>
<td><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.valuetype.gethashcode#system-valuetype-gethashcode">ValueType.GetHashCode()</a></div>
<div><span class="xref">System.ValueType.GetHashCode()</span></div>


<a id="Algorand_Unity_Address_CheckSum_GetUnsafePtr_" data-uid="Algorand.Unity.Address.CheckSum.GetUnsafePtr*"></a>
Expand Down Expand Up @@ -2156,13 +2156,13 @@ <h5 class="returns">Returns</h5>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">String</a></td>
<td><span class="xref">System.String</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.valuetype.tostring#system-valuetype-tostring">ValueType.ToString()</a></div>
<div><span class="xref">System.ValueType.ToString()</span></div>
<h3 id="operators">Operators
</h3>

Expand Down Expand Up @@ -2207,7 +2207,7 @@ <h5 class="returns">Returns</h5>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
Expand Down Expand Up @@ -2296,7 +2296,7 @@ <h5 class="returns">Returns</h5>
</thead>
<tbody>
<tr>
<td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">Boolean</a></td>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
Expand Down
Loading

0 comments on commit e28e906

Please sign in to comment.