Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
pardeike-bot committed Jan 24, 2020
1 parent 23c2a23 commit 844f10e
Show file tree
Hide file tree
Showing 17 changed files with 143 additions and 211 deletions.
2 changes: 1 addition & 1 deletion docs/api/HarmonyLib.AccessTools.FieldRef-1.html
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ <h5 class="typeParameters">Type Parameters</h5>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_AccessTools_FieldRef_1.md&amp;value=---%0Auid%3A%20HarmonyLib.AccessTools.FieldRef%601%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" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Tools/AccessTools.cs/#L845" class="contribution-link">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Tools/AccessTools.cs/#L839" class="contribution-link">View Source</a>
</li>
</ul>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/HarmonyLib.AccessTools.FieldRef-2.html
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ <h5 class="typeParameters">Type Parameters</h5>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_AccessTools_FieldRef_2.md&amp;value=---%0Auid%3A%20HarmonyLib.AccessTools.FieldRef%602%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" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Tools/AccessTools.cs/#L776" class="contribution-link">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Tools/AccessTools.cs/#L777" class="contribution-link">View Source</a>
</li>
</ul>
</div>
Expand Down
118 changes: 59 additions & 59 deletions docs/api/HarmonyLib.AccessTools.html

Large diffs are not rendered by default.

14 changes: 7 additions & 7 deletions docs/api/HarmonyLib.FastAccess.html
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ <h3 id="methods">Methods
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_FastAccess_CreateFieldGetter__2_System_String___.md&amp;value=---%0Auid%3A%20HarmonyLib.FastAccess.CreateFieldGetter%60%602(System.String%5B%5D)%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/Extras/FastAccess.cs/#L103">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Extras/FastAccess.cs/#L102">View Source</a>
</span>
<a id="HarmonyLib_FastAccess_CreateFieldGetter_" data-uid="HarmonyLib.FastAccess.CreateFieldGetter*"></a>
<h4 id="HarmonyLib_FastAccess_CreateFieldGetter__2_System_String___" data-uid="HarmonyLib.FastAccess.CreateFieldGetter``2(System.String[])">CreateFieldGetter&lt;T, S&gt;(String[])</h4>
Expand Down Expand Up @@ -189,7 +189,7 @@ <h5 class="typeParameters">Type Parameters</h5>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_FastAccess_CreateGetterHandler__2_System_Reflection_FieldInfo_.md&amp;value=---%0Auid%3A%20HarmonyLib.FastAccess.CreateGetterHandler%60%602(System.Reflection.FieldInfo)%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/Extras/FastAccess.cs/#L85">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Extras/FastAccess.cs/#L84">View Source</a>
</span>
<a id="HarmonyLib_FastAccess_CreateGetterHandler_" data-uid="HarmonyLib.FastAccess.CreateGetterHandler*"></a>
<h4 id="HarmonyLib_FastAccess_CreateGetterHandler__2_System_Reflection_FieldInfo_" data-uid="HarmonyLib.FastAccess.CreateGetterHandler``2(System.Reflection.FieldInfo)">CreateGetterHandler&lt;T, S&gt;(FieldInfo)</h4>
Expand Down Expand Up @@ -260,7 +260,7 @@ <h5 class="typeParameters">Type Parameters</h5>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_FastAccess_CreateGetterHandler__2_System_Reflection_PropertyInfo_.md&amp;value=---%0Auid%3A%20HarmonyLib.FastAccess.CreateGetterHandler%60%602(System.Reflection.PropertyInfo)%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/Extras/FastAccess.cs/#L66">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Extras/FastAccess.cs/#L65">View Source</a>
</span>
<a id="HarmonyLib_FastAccess_CreateGetterHandler_" data-uid="HarmonyLib.FastAccess.CreateGetterHandler*"></a>
<h4 id="HarmonyLib_FastAccess_CreateGetterHandler__2_System_Reflection_PropertyInfo_" data-uid="HarmonyLib.FastAccess.CreateGetterHandler``2(System.Reflection.PropertyInfo)">CreateGetterHandler&lt;T, S&gt;(PropertyInfo)</h4>
Expand Down Expand Up @@ -331,7 +331,7 @@ <h5 class="typeParameters">Type Parameters</h5>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_FastAccess_CreateInstantiationHandler__1.md&amp;value=---%0Auid%3A%20HarmonyLib.FastAccess.CreateInstantiationHandler%60%601%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/Extras/FastAccess.cs/#L39">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Extras/FastAccess.cs/#L40">View Source</a>
</span>
<a id="HarmonyLib_FastAccess_CreateInstantiationHandler_" data-uid="HarmonyLib.FastAccess.CreateInstantiationHandler*"></a>
<h4 id="HarmonyLib_FastAccess_CreateInstantiationHandler__1" data-uid="HarmonyLib.FastAccess.CreateInstantiationHandler``1">CreateInstantiationHandler&lt;T&gt;()</h4>
Expand Down Expand Up @@ -379,7 +379,7 @@ <h5 class="typeParameters">Type Parameters</h5>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_FastAccess_CreateSetterHandler__2_System_Reflection_FieldInfo_.md&amp;value=---%0Auid%3A%20HarmonyLib.FastAccess.CreateSetterHandler%60%602(System.Reflection.FieldInfo)%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/Extras/FastAccess.cs/#L145">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Extras/FastAccess.cs/#L144">View Source</a>
</span>
<a id="HarmonyLib_FastAccess_CreateSetterHandler_" data-uid="HarmonyLib.FastAccess.CreateSetterHandler*"></a>
<h4 id="HarmonyLib_FastAccess_CreateSetterHandler__2_System_Reflection_FieldInfo_" data-uid="HarmonyLib.FastAccess.CreateSetterHandler``2(System.Reflection.FieldInfo)">CreateSetterHandler&lt;T, S&gt;(FieldInfo)</h4>
Expand Down Expand Up @@ -450,7 +450,7 @@ <h5 class="typeParameters">Type Parameters</h5>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_FastAccess_CreateSetterHandler__2_System_Reflection_PropertyInfo_.md&amp;value=---%0Auid%3A%20HarmonyLib.FastAccess.CreateSetterHandler%60%602(System.Reflection.PropertyInfo)%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/Extras/FastAccess.cs/#L125">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Extras/FastAccess.cs/#L124">View Source</a>
</span>
<a id="HarmonyLib_FastAccess_CreateSetterHandler_" data-uid="HarmonyLib.FastAccess.CreateSetterHandler*"></a>
<h4 id="HarmonyLib_FastAccess_CreateSetterHandler__2_System_Reflection_PropertyInfo_" data-uid="HarmonyLib.FastAccess.CreateSetterHandler``2(System.Reflection.PropertyInfo)">CreateSetterHandler&lt;T, S&gt;(PropertyInfo)</h4>
Expand Down Expand Up @@ -527,7 +527,7 @@ <h5 class="typeParameters">Type Parameters</h5>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_FastAccess.md&amp;value=---%0Auid%3A%20HarmonyLib.FastAccess%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" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Extras/FastAccess.cs/#L33" class="contribution-link">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Extras/FastAccess.cs/#L34" class="contribution-link">View Source</a>
</li>
</ul>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/HarmonyLib.FastInvokeHandler.html
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ <h5 class="returns">Returns</h5>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_FastInvokeHandler.md&amp;value=---%0Auid%3A%20HarmonyLib.FastInvokeHandler%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" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Extras/MethodInvoker.cs/#L13" class="contribution-link">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Extras/MethodInvoker.cs/#L14" class="contribution-link">View Source</a>
</li>
</ul>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/HarmonyLib.GetterHandler-2.html
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ <h5 class="typeParameters">Type Parameters</h5>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_GetterHandler_2.md&amp;value=---%0Auid%3A%20HarmonyLib.GetterHandler%602%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" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Extras/FastAccess.cs/#L15" class="contribution-link">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Extras/FastAccess.cs/#L16" class="contribution-link">View Source</a>
</li>
</ul>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/api/HarmonyLib.Harmony.html
Original file line number Diff line number Diff line change
Expand Up @@ -422,7 +422,7 @@ <h4 id="HarmonyLib_Harmony_Patch_System_Reflection_MethodBase_HarmonyLib_Harmony
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public DynamicMethod Patch(MethodBase original, HarmonyMethod prefix = null, HarmonyMethod postfix = null, HarmonyMethod transpiler = null, HarmonyMethod finalizer = null)</code></pre>
<pre><code class="lang-csharp hljs">public MethodInfo Patch(MethodBase original, HarmonyMethod prefix = null, HarmonyMethod postfix = null, HarmonyMethod transpiler = null, HarmonyMethod finalizer = null)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
Expand Down Expand Up @@ -476,7 +476,7 @@ <h5 class="returns">Returns</h5>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Reflection.Emit.DynamicMethod</span></td>
<td><span class="xref">System.Reflection.MethodInfo</span></td>
<td><p>The dynamic method that was created to patch the original method</p>
</td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion docs/api/HarmonyLib.InstantiationHandler-1.html
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ <h5 class="typeParameters">Type Parameters</h5>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_InstantiationHandler_1.md&amp;value=---%0Auid%3A%20HarmonyLib.InstantiationHandler%601%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" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Extras/FastAccess.cs/#L30" class="contribution-link">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Extras/FastAccess.cs/#L31" class="contribution-link">View Source</a>
</li>
</ul>
</div>
Expand Down
10 changes: 5 additions & 5 deletions docs/api/HarmonyLib.Memory.html
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ <h3 id="methods">Methods
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_Memory_DetourMethod_System_Reflection_MethodBase_System_Reflection_MethodBase_.md&amp;value=---%0Auid%3A%20HarmonyLib.Memory.DetourMethod(System.Reflection.MethodBase%2CSystem.Reflection.MethodBase)%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/Internal/Memory.cs/#L96">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Internal/Memory.cs/#L30">View Source</a>
</span>
<a id="HarmonyLib_Memory_DetourMethod_" data-uid="HarmonyLib.Memory.DetourMethod*"></a>
<h4 id="HarmonyLib_Memory_DetourMethod_System_Reflection_MethodBase_System_Reflection_MethodBase_" data-uid="HarmonyLib.Memory.DetourMethod(System.Reflection.MethodBase,System.Reflection.MethodBase)">DetourMethod(MethodBase, MethodBase)</h4>
Expand Down Expand Up @@ -174,7 +174,7 @@ <h5 class="returns">Returns</h5>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_Memory_GetMethodStart_System_Reflection_MethodBase_System_Exception__.md&amp;value=---%0Auid%3A%20HarmonyLib.Memory.GetMethodStart(System.Reflection.MethodBase%2CSystem.Exception%40)%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/Internal/Memory.cs/#L178">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Internal/Memory.cs/#L63">View Source</a>
</span>
<a id="HarmonyLib_Memory_GetMethodStart_" data-uid="HarmonyLib.Memory.GetMethodStart*"></a>
<h4 id="HarmonyLib_Memory_GetMethodStart_System_Reflection_MethodBase_System_Exception__" data-uid="HarmonyLib.Memory.GetMethodStart(System.Reflection.MethodBase,System.Exception@)">GetMethodStart(MethodBase, out Exception)</h4>
Expand Down Expand Up @@ -230,7 +230,7 @@ <h5 class="returns">Returns</h5>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_Memory_MarkForNoInlining_System_Reflection_MethodBase_.md&amp;value=---%0Auid%3A%20HarmonyLib.Memory.MarkForNoInlining(System.Reflection.MethodBase)%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/Internal/Memory.cs/#L79">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Internal/Memory.cs/#L13">View Source</a>
</span>
<a id="HarmonyLib_Memory_MarkForNoInlining_" data-uid="HarmonyLib.Memory.MarkForNoInlining*"></a>
<h4 id="HarmonyLib_Memory_MarkForNoInlining_System_Reflection_MethodBase_" data-uid="HarmonyLib.Memory.MarkForNoInlining(System.Reflection.MethodBase)">MarkForNoInlining(MethodBase)</h4>
Expand Down Expand Up @@ -264,7 +264,7 @@ <h5 class="parameters">Parameters</h5>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_Memory_WriteJump_System_Int64_System_Int64_.md&amp;value=---%0Auid%3A%20HarmonyLib.Memory.WriteJump(System.Int64%2CSystem.Int64)%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/Internal/Memory.cs/#L122">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Internal/Memory.cs/#L47">View Source</a>
</span>
<a id="HarmonyLib_Memory_WriteJump_" data-uid="HarmonyLib.Memory.WriteJump*"></a>
<h4 id="HarmonyLib_Memory_WriteJump_System_Int64_System_Int64_" data-uid="HarmonyLib.Memory.WriteJump(System.Int64,System.Int64)">WriteJump(Int64, Int64)</h4>
Expand Down Expand Up @@ -326,7 +326,7 @@ <h5 class="returns">Returns</h5>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_Memory.md&amp;value=---%0Auid%3A%20HarmonyLib.Memory%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" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Internal/Memory.cs/#L40" class="contribution-link">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Internal/Memory.cs/#L9" class="contribution-link">View Source</a>
</li>
</ul>
</div>
Expand Down
Loading

0 comments on commit 844f10e

Please sign in to comment.