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 Mar 29, 2024
1 parent 395749f commit 5054c98
Show file tree
Hide file tree
Showing 5 changed files with 138 additions and 16 deletions.
92 changes: 83 additions & 9 deletions docs/api/HarmonyLib.Harmony.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -354,7 +354,7 @@ <h5 class="returns">Returns</h5>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_Harmony_GetAllPatchedMethods.md&amp;value=---%0Auid%3A%20HarmonyLib.Harmony.GetAllPatchedMethods%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/Harmony.cs/#L251">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/Harmony.cs/#L277">View Source</a>
</span>
<a id="HarmonyLib_Harmony_GetAllPatchedMethods_" data-uid="HarmonyLib.Harmony.GetAllPatchedMethods*"></a>
<h4 id="HarmonyLib_Harmony_GetAllPatchedMethods" data-uid="HarmonyLib.Harmony.GetAllPatchedMethods">GetAllPatchedMethods()</h4>
Expand Down Expand Up @@ -386,7 +386,7 @@ <h5 class="returns">Returns</h5>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_Harmony_GetMethodFromStackframe_System_Diagnostics_StackFrame_.md&amp;value=---%0Auid%3A%20HarmonyLib.Harmony.GetMethodFromStackframe(System.Diagnostics.StackFrame)%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/Harmony.cs/#L267">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/Harmony.cs/#L293">View Source</a>
</span>
<a id="HarmonyLib_Harmony_GetMethodFromStackframe_" data-uid="HarmonyLib.Harmony.GetMethodFromStackframe*"></a>
<h4 id="HarmonyLib_Harmony_GetMethodFromStackframe_System_Diagnostics_StackFrame_" data-uid="HarmonyLib.Harmony.GetMethodFromStackframe(System.Diagnostics.StackFrame)">GetMethodFromStackframe(StackFrame)</h4>
Expand Down Expand Up @@ -436,7 +436,7 @@ <h5 class="returns">Returns</h5>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_Harmony_GetOriginalMethod_System_Reflection_MethodInfo_.md&amp;value=---%0Auid%3A%20HarmonyLib.Harmony.GetOriginalMethod(System.Reflection.MethodInfo)%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/Harmony.cs/#L257">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/Harmony.cs/#L283">View Source</a>
</span>
<a id="HarmonyLib_Harmony_GetOriginalMethod_" data-uid="HarmonyLib.Harmony.GetOriginalMethod*"></a>
<h4 id="HarmonyLib_Harmony_GetOriginalMethod_System_Reflection_MethodInfo_" data-uid="HarmonyLib.Harmony.GetOriginalMethod(System.Reflection.MethodInfo)">GetOriginalMethod(MethodInfo)</h4>
Expand Down Expand Up @@ -486,7 +486,7 @@ <h5 class="returns">Returns</h5>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_Harmony_GetOriginalMethodFromStackframe_System_Diagnostics_StackFrame_.md&amp;value=---%0Auid%3A%20HarmonyLib.Harmony.GetOriginalMethodFromStackframe(System.Diagnostics.StackFrame)%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/Harmony.cs/#L276">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/Harmony.cs/#L302">View Source</a>
</span>
<a id="HarmonyLib_Harmony_GetOriginalMethodFromStackframe_" data-uid="HarmonyLib.Harmony.GetOriginalMethodFromStackframe*"></a>
<h4 id="HarmonyLib_Harmony_GetOriginalMethodFromStackframe_System_Diagnostics_StackFrame_" data-uid="HarmonyLib.Harmony.GetOriginalMethodFromStackframe(System.Diagnostics.StackFrame)">GetOriginalMethodFromStackframe(StackFrame)</h4>
Expand Down Expand Up @@ -536,7 +536,7 @@ <h5 class="returns">Returns</h5>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_Harmony_GetPatchedMethods.md&amp;value=---%0Auid%3A%20HarmonyLib.Harmony.GetPatchedMethods%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/Harmony.cs/#L242">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/Harmony.cs/#L268">View Source</a>
</span>
<a id="HarmonyLib_Harmony_GetPatchedMethods_" data-uid="HarmonyLib.Harmony.GetPatchedMethods*"></a>
<h4 id="HarmonyLib_Harmony_GetPatchedMethods" data-uid="HarmonyLib.Harmony.GetPatchedMethods">GetPatchedMethods()</h4>
Expand Down Expand Up @@ -568,7 +568,7 @@ <h5 class="returns">Returns</h5>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_Harmony_GetPatchInfo_System_Reflection_MethodBase_.md&amp;value=---%0Auid%3A%20HarmonyLib.Harmony.GetPatchInfo(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/Public/Harmony.cs/#L237">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/Harmony.cs/#L263">View Source</a>
</span>
<a id="HarmonyLib_Harmony_GetPatchInfo_" data-uid="HarmonyLib.Harmony.GetPatchInfo*"></a>
<h4 id="HarmonyLib_Harmony_GetPatchInfo_System_Reflection_MethodBase_" data-uid="HarmonyLib.Harmony.GetPatchInfo(System.Reflection.MethodBase)">GetPatchInfo(MethodBase)</h4>
Expand Down Expand Up @@ -618,7 +618,7 @@ <h5 class="returns">Returns</h5>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_Harmony_HasAnyPatches_System_String_.md&amp;value=---%0Auid%3A%20HarmonyLib.Harmony.HasAnyPatches(System.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>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/Harmony.cs/#L226">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/Harmony.cs/#L252">View Source</a>
</span>
<a id="HarmonyLib_Harmony_HasAnyPatches_" data-uid="HarmonyLib.Harmony.HasAnyPatches*"></a>
<h4 id="HarmonyLib_Harmony_HasAnyPatches_System_String_" data-uid="HarmonyLib.Harmony.HasAnyPatches(System.String)">HasAnyPatches(String)</h4>
Expand Down Expand Up @@ -889,7 +889,7 @@ <h5 class="parameters">Parameters</h5>
</span>
<a id="HarmonyLib_Harmony_PatchCategory_" data-uid="HarmonyLib.Harmony.PatchCategory*"></a>
<h4 id="HarmonyLib_Harmony_PatchCategory_System_String_" data-uid="HarmonyLib.Harmony.PatchCategory(System.String)">PatchCategory(String)</h4>
<div class="markdown level1 summary"><p>Searches an assembly for Harmony annotations with a specific category and uses them to create patches</p>
<div class="markdown level1 summary"><p>Searches the current assembly for Harmony annotations with a specific category and uses them to create patches</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
Expand Down Expand Up @@ -1099,12 +1099,86 @@ <h5 class="parameters">Parameters</h5>
<h5 id="HarmonyLib_Harmony_UnpatchAll_System_String__remarks">Remarks</h5>
<div class="markdown level1 remarks"><p>This method could be static if it wasn't for the fact that unpatching creates a new replacement method that contains your harmony ID</p>
</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_Harmony_UnpatchCategory_System_Reflection_Assembly_System_String_.md&amp;value=---%0Auid%3A%20HarmonyLib.Harmony.UnpatchCategory(System.Reflection.Assembly%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>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/Harmony.cs/#L236">View Source</a>
</span>
<a id="HarmonyLib_Harmony_UnpatchCategory_" data-uid="HarmonyLib.Harmony.UnpatchCategory*"></a>
<h4 id="HarmonyLib_Harmony_UnpatchCategory_System_Reflection_Assembly_System_String_" data-uid="HarmonyLib.Harmony.UnpatchCategory(System.Reflection.Assembly,System.String)">UnpatchCategory(Assembly, String)</h4>
<div class="markdown level1 summary"><p>Searches an assembly for types with a specific category annotation and uses them to unpatch existing patches. Fully unpatching is not supported. Be careful, unpatching is global</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void UnpatchCategory(Assembly assembly, string category)</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.Reflection.Assembly</span></td>
<td><span class="parametername">assembly</span></td>
<td><p>The assembly</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">category</span></td>
<td><p>Name of patch category</p>
</td>
</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_Harmony_UnpatchCategory_System_String_.md&amp;value=---%0Auid%3A%20HarmonyLib.Harmony.UnpatchCategory(System.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>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/Harmony.cs/#L225">View Source</a>
</span>
<a id="HarmonyLib_Harmony_UnpatchCategory_" data-uid="HarmonyLib.Harmony.UnpatchCategory*"></a>
<h4 id="HarmonyLib_Harmony_UnpatchCategory_System_String_" data-uid="HarmonyLib.Harmony.UnpatchCategory(System.String)">UnpatchCategory(String)</h4>
<div class="markdown level1 summary"><p>Searches the current assembly for types with a specific category annotation and uses them to unpatch existing patches. Fully unpatching is not supported. Be careful, unpatching is global</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void UnpatchCategory(string category)</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.String</span></td>
<td><span class="parametername">category</span></td>
<td><p>Name of patch category</p>
</td>
</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_Harmony_VersionInfo_System_Version__.md&amp;value=---%0Auid%3A%20HarmonyLib.Harmony.VersionInfo(System.Version%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/Public/Harmony.cs/#L286">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/Harmony.cs/#L312">View Source</a>
</span>
<a id="HarmonyLib_Harmony_VersionInfo_" data-uid="HarmonyLib.Harmony.VersionInfo*"></a>
<h4 id="HarmonyLib_Harmony_VersionInfo_System_Version__" data-uid="HarmonyLib.Harmony.VersionInfo(System.Version@)">VersionInfo(out Version)</h4>
Expand Down
8 changes: 4 additions & 4 deletions docs/api/HarmonyLib.HarmonyMethodExtensions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ <h5 class="parameters">Parameters</h5>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_HarmonyMethodExtensions_GetFromMethod_System_Reflection_MethodBase_.md&amp;value=---%0Auid%3A%20HarmonyLib.HarmonyMethodExtensions.GetFromMethod(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/Public/HarmonyMethod.cs/#L310">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/HarmonyMethod.cs/#L322">View Source</a>
</span>
<a id="HarmonyLib_HarmonyMethodExtensions_GetFromMethod_" data-uid="HarmonyLib.HarmonyMethodExtensions.GetFromMethod*"></a>
<h4 id="HarmonyLib_HarmonyMethodExtensions_GetFromMethod_System_Reflection_MethodBase_" data-uid="HarmonyLib.HarmonyMethodExtensions.GetFromMethod(System.Reflection.MethodBase)">GetFromMethod(MethodBase)</h4>
Expand Down Expand Up @@ -234,7 +234,7 @@ <h5 class="returns">Returns</h5>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_HarmonyMethodExtensions_GetFromType_System_Type_.md&amp;value=---%0Auid%3A%20HarmonyLib.HarmonyMethodExtensions.GetFromType(System.Type)%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/HarmonyMethod.cs/#L292">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/HarmonyMethod.cs/#L304">View Source</a>
</span>
<a id="HarmonyLib_HarmonyMethodExtensions_GetFromType_" data-uid="HarmonyLib.HarmonyMethodExtensions.GetFromType*"></a>
<h4 id="HarmonyLib_HarmonyMethodExtensions_GetFromType_System_Type_" data-uid="HarmonyLib.HarmonyMethodExtensions.GetFromType(System.Type)">GetFromType(Type)</h4>
Expand Down Expand Up @@ -284,7 +284,7 @@ <h5 class="returns">Returns</h5>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_HarmonyMethodExtensions_GetMergedFromMethod_System_Reflection_MethodBase_.md&amp;value=---%0Auid%3A%20HarmonyLib.HarmonyMethodExtensions.GetMergedFromMethod(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/Public/HarmonyMethod.cs/#L322">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/HarmonyMethod.cs/#L334">View Source</a>
</span>
<a id="HarmonyLib_HarmonyMethodExtensions_GetMergedFromMethod_" data-uid="HarmonyLib.HarmonyMethodExtensions.GetMergedFromMethod*"></a>
<h4 id="HarmonyLib_HarmonyMethodExtensions_GetMergedFromMethod_System_Reflection_MethodBase_" data-uid="HarmonyLib.HarmonyMethodExtensions.GetMergedFromMethod(System.Reflection.MethodBase)">GetMergedFromMethod(MethodBase)</h4>
Expand Down Expand Up @@ -334,7 +334,7 @@ <h5 class="returns">Returns</h5>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_HarmonyMethodExtensions_GetMergedFromType_System_Type_.md&amp;value=---%0Auid%3A%20HarmonyLib.HarmonyMethodExtensions.GetMergedFromType(System.Type)%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/HarmonyMethod.cs/#L304">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/HarmonyMethod.cs/#L316">View Source</a>
</span>
<a id="HarmonyLib_HarmonyMethodExtensions_GetMergedFromType_" data-uid="HarmonyLib.HarmonyMethodExtensions.GetMergedFromType*"></a>
<h4 id="HarmonyLib_HarmonyMethodExtensions_GetMergedFromType_System_Type_" data-uid="HarmonyLib.HarmonyMethodExtensions.GetMergedFromType(System.Type)">GetMergedFromType(Type)</h4>
Expand Down
16 changes: 16 additions & 0 deletions docs/api/HarmonyLib.PatchClassProcessor.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,22 @@ <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_PatchClassProcessor_Unpatch.md&amp;value=---%0Auid%3A%20HarmonyLib.PatchClassProcessor.Unpatch%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/PatchClassProcessor.cs/#L113">View Source</a>
</span>
<a id="HarmonyLib_PatchClassProcessor_Unpatch_" data-uid="HarmonyLib.PatchClassProcessor.Unpatch*"></a>
<h4 id="HarmonyLib_PatchClassProcessor_Unpatch" data-uid="HarmonyLib.PatchClassProcessor.Unpatch">Unpatch()</h4>
<div class="markdown level1 summary"><p>REmoves the patches</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Unpatch()</code></pre>
</div>
</article>
</div>

Expand Down
Loading

0 comments on commit 5054c98

Please sign in to comment.