Skip to content

Commit

Permalink
Update documentation [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
@pardeike-bot
pardeike-bot committed Oct 4, 2022
1 parent 5f76f1c commit 3fe1b46
Show file tree
Hide file tree
Showing 85 changed files with 883 additions and 187 deletions.
2 changes: 1 addition & 1 deletion docs/api/HarmonyLib.AccessTools.FieldRef-1.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<meta name="viewport" content="width=device-width">
<meta name="title" content="Delegate AccessTools.FieldRef&lt;F&gt;
">
<meta name="generator" content="docfx 2.59.3.0">
<meta name="generator" content="docfx 2.59.4.0">

<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
Expand Down
2 changes: 1 addition & 1 deletion docs/api/HarmonyLib.AccessTools.FieldRef-2.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<meta name="viewport" content="width=device-width">
<meta name="title" content="Delegate AccessTools.FieldRef&lt;T, F&gt;
">
<meta name="generator" content="docfx 2.59.3.0">
<meta name="generator" content="docfx 2.59.4.0">

<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
Expand Down
2 changes: 1 addition & 1 deletion docs/api/HarmonyLib.AccessTools.StructFieldRef-2.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<meta name="viewport" content="width=device-width">
<meta name="title" content="Delegate AccessTools.StructFieldRef&lt;T, F&gt;
">
<meta name="generator" content="docfx 2.59.3.0">
<meta name="generator" content="docfx 2.59.4.0">

<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
Expand Down
2 changes: 1 addition & 1 deletion docs/api/HarmonyLib.AccessTools.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class AccessTools
">
<meta name="generator" content="docfx 2.59.3.0">
<meta name="generator" content="docfx 2.59.4.0">

<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
Expand Down
2 changes: 1 addition & 1 deletion docs/api/HarmonyLib.ArgumentType.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<meta name="viewport" content="width=device-width">
<meta name="title" content="Enum ArgumentType
">
<meta name="generator" content="docfx 2.59.3.0">
<meta name="generator" content="docfx 2.59.4.0">

<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
Expand Down
2 changes: 1 addition & 1 deletion docs/api/HarmonyLib.Code.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class Code
">
<meta name="generator" content="docfx 2.59.3.0">
<meta name="generator" content="docfx 2.59.4.0">

<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
Expand Down
234 changes: 232 additions & 2 deletions docs/api/HarmonyLib.CodeInstruction.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class CodeInstruction
">
<meta name="generator" content="docfx 2.59.3.0">
<meta name="generator" content="docfx 2.59.4.0">

<link rel="shortcut icon" href="../favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
Expand Down Expand Up @@ -868,6 +868,65 @@ <h5 class="returns">Returns</h5>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_CodeInstruction_LoadArgument_System_Int32_System_Boolean_.md&amp;value=---%0Auid%3A%20HarmonyLib.CodeInstruction.LoadArgument(System.Int32%2CSystem.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/CodeInstruction.cs/#L278">View Source</a>
</span>
<a id="HarmonyLib_CodeInstruction_LoadArgument_" data-uid="HarmonyLib.CodeInstruction.LoadArgument*"></a>
<h4 id="HarmonyLib_CodeInstruction_LoadArgument_System_Int32_System_Boolean_" data-uid="HarmonyLib.CodeInstruction.LoadArgument(System.Int32,System.Boolean)">LoadArgument(Int32, Boolean)</h4>
<div class="markdown level1 summary"><p>Creates a CodeInstruction loading an argument with the given index, using the shorter forms when possible</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static CodeInstruction LoadArgument(int index, bool useAddress = false)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">index</span></td>
<td><p>The index of the argument</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">useAddress</span></td>
<td><p>Use address of argument</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="HarmonyLib.CodeInstruction.html">CodeInstruction</a></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="HarmonyLib_CodeInstruction_LoadArgument_System_Int32_System_Boolean__seealso">See Also</h5>
<div class="seealso">
<div><a class="xref" href="HarmonyLib.CodeInstructionExtensions.html#HarmonyLib_CodeInstructionExtensions_ArgumentIndex_HarmonyLib_CodeInstruction_">ArgumentIndex</a>(<a class="xref" href="HarmonyLib.CodeInstruction.html">CodeInstruction</a>)</div>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_CodeInstruction_LoadField_System_Type_System_String_System_Boolean_.md&amp;value=---%0Auid%3A%20HarmonyLib.CodeInstruction.LoadField(System.Type%2CSystem.String%2CSystem.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
Expand Down Expand Up @@ -929,6 +988,118 @@ <h5 class="returns">Returns</h5>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_CodeInstruction_LoadLocal_System_Int32_System_Boolean_.md&amp;value=---%0Auid%3A%20HarmonyLib.CodeInstruction.LoadLocal(System.Int32%2CSystem.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/CodeInstruction.cs/#L239">View Source</a>
</span>
<a id="HarmonyLib_CodeInstruction_LoadLocal_" data-uid="HarmonyLib.CodeInstruction.LoadLocal*"></a>
<h4 id="HarmonyLib_CodeInstruction_LoadLocal_System_Int32_System_Boolean_" data-uid="HarmonyLib.CodeInstruction.LoadLocal(System.Int32,System.Boolean)">LoadLocal(Int32, Boolean)</h4>
<div class="markdown level1 summary"><p>Creates a CodeInstruction loading a local with the given index, using the shorter forms when possible</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static CodeInstruction LoadLocal(int index, bool useAddress = false)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">index</span></td>
<td><p>The index where the local is stored</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">useAddress</span></td>
<td><p>Use address of local</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="HarmonyLib.CodeInstruction.html">CodeInstruction</a></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="HarmonyLib_CodeInstruction_LoadLocal_System_Int32_System_Boolean__seealso">See Also</h5>
<div class="seealso">
<div><a class="xref" href="HarmonyLib.CodeInstructionExtensions.html#HarmonyLib_CodeInstructionExtensions_LocalIndex_HarmonyLib_CodeInstruction_">LocalIndex</a>(<a class="xref" href="HarmonyLib.CodeInstruction.html">CodeInstruction</a>)</div>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_CodeInstruction_StoreArgument_System_Int32_.md&amp;value=---%0Auid%3A%20HarmonyLib.CodeInstruction.StoreArgument(System.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/CodeInstruction.cs/#L300">View Source</a>
</span>
<a id="HarmonyLib_CodeInstruction_StoreArgument_" data-uid="HarmonyLib.CodeInstruction.StoreArgument*"></a>
<h4 id="HarmonyLib_CodeInstruction_StoreArgument_System_Int32_" data-uid="HarmonyLib.CodeInstruction.StoreArgument(System.Int32)">StoreArgument(Int32)</h4>
<div class="markdown level1 summary"><p>Creates a CodeInstruction storing to an argument with the given index, using the shorter forms when possible</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static CodeInstruction StoreArgument(int index)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">index</span></td>
<td><p>The index of the argument</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="HarmonyLib.CodeInstruction.html">CodeInstruction</a></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="HarmonyLib_CodeInstruction_StoreArgument_System_Int32__seealso">See Also</h5>
<div class="seealso">
<div><a class="xref" href="HarmonyLib.CodeInstructionExtensions.html#HarmonyLib_CodeInstructionExtensions_ArgumentIndex_HarmonyLib_CodeInstruction_">ArgumentIndex</a>(<a class="xref" href="HarmonyLib.CodeInstruction.html">CodeInstruction</a>)</div>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_CodeInstruction_StoreField_System_Type_System_String_.md&amp;value=---%0Auid%3A%20HarmonyLib.CodeInstruction.StoreField(System.Type%2CSystem.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
Expand Down Expand Up @@ -984,12 +1155,65 @@ <h5 class="returns">Returns</h5>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_CodeInstruction_StoreLocal_System_Int32_.md&amp;value=---%0Auid%3A%20HarmonyLib.CodeInstruction.StoreLocal(System.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/CodeInstruction.cs/#L261">View Source</a>
</span>
<a id="HarmonyLib_CodeInstruction_StoreLocal_" data-uid="HarmonyLib.CodeInstruction.StoreLocal*"></a>
<h4 id="HarmonyLib_CodeInstruction_StoreLocal_System_Int32_" data-uid="HarmonyLib.CodeInstruction.StoreLocal(System.Int32)">StoreLocal(Int32)</h4>
<div class="markdown level1 summary"><p>Creates a CodeInstruction storing to a local with the given index, using the shorter forms when possible</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static CodeInstruction StoreLocal(int index)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">index</span></td>
<td><p>The index where the local is stored</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="HarmonyLib.CodeInstruction.html">CodeInstruction</a></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="HarmonyLib_CodeInstruction_StoreLocal_System_Int32__seealso">See Also</h5>
<div class="seealso">
<div><a class="xref" href="HarmonyLib.CodeInstructionExtensions.html#HarmonyLib_CodeInstructionExtensions_LocalIndex_HarmonyLib_CodeInstruction_">LocalIndex</a>(<a class="xref" href="HarmonyLib.CodeInstruction.html">CodeInstruction</a>)</div>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_CodeInstruction_ToString.md&amp;value=---%0Auid%3A%20HarmonyLib.CodeInstruction.ToString%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/CodeInstruction.cs/#L237">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/CodeInstruction.cs/#L311">View Source</a>
</span>
<a id="HarmonyLib_CodeInstruction_ToString_" data-uid="HarmonyLib.CodeInstruction.ToString*"></a>
<h4 id="HarmonyLib_CodeInstruction_ToString" data-uid="HarmonyLib.CodeInstruction.ToString">ToString()</h4>
Expand Down Expand Up @@ -1067,6 +1291,12 @@ <h3 id="extensionmethods">Extension Methods</h3>
<div>
<a class="xref" href="HarmonyLib.CodeInstructionExtensions.html#HarmonyLib_CodeInstructionExtensions_StoresField_HarmonyLib_CodeInstruction_System_Reflection_FieldInfo_">CodeInstructionExtensions.StoresField(CodeInstruction, FieldInfo)</a>
</div>
<div>
<a class="xref" href="HarmonyLib.CodeInstructionExtensions.html#HarmonyLib_CodeInstructionExtensions_LocalIndex_HarmonyLib_CodeInstruction_">CodeInstructionExtensions.LocalIndex(CodeInstruction)</a>
</div>
<div>
<a class="xref" href="HarmonyLib.CodeInstructionExtensions.html#HarmonyLib_CodeInstructionExtensions_ArgumentIndex_HarmonyLib_CodeInstruction_">CodeInstructionExtensions.ArgumentIndex(CodeInstruction)</a>
</div>
<div>
<a class="xref" href="HarmonyLib.CodeInstructionExtensions.html#HarmonyLib_CodeInstructionExtensions_WithLabels_HarmonyLib_CodeInstruction_System_Reflection_Emit_Label___">CodeInstructionExtensions.WithLabels(CodeInstruction, Label[])</a>
</div>
Expand Down

0 comments on commit 3fe1b46

Please sign in to comment.