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 Jul 19, 2022
1 parent d1aa13b commit 5a48778
Show file tree
Hide file tree
Showing 3 changed files with 107 additions and 12 deletions.
102 changes: 91 additions & 11 deletions docs/api/HarmonyLib.CodeMatch.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ <h3 id="constructors">Constructors
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_CodeMatch__ctor_HarmonyLib_CodeInstruction_System_String_.md&amp;value=---%0Auid%3A%20HarmonyLib.CodeMatch.%23ctor(HarmonyLib.CodeInstruction%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/Tools/CodeMatch.cs/#L59">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Tools/CodeMatch.cs/#L90">View Source</a>
</span>
<a id="HarmonyLib_CodeMatch__ctor_" data-uid="HarmonyLib.CodeMatch.#ctor*"></a>
<h4 id="HarmonyLib_CodeMatch__ctor_HarmonyLib_CodeInstruction_System_String_" data-uid="HarmonyLib.CodeMatch.#ctor(HarmonyLib.CodeInstruction,System.String)">CodeMatch(CodeInstruction, String)</h4>
Expand Down Expand Up @@ -204,7 +204,7 @@ <h5 class="parameters">Parameters</h5>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_CodeMatch__ctor_System_Func_HarmonyLib_CodeInstruction_System_Boolean__System_String_.md&amp;value=---%0Auid%3A%20HarmonyLib.CodeMatch.%23ctor(System.Func%7BHarmonyLib.CodeInstruction%2CSystem.Boolean%7D%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/Tools/CodeMatch.cs/#L67">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Tools/CodeMatch.cs/#L98">View Source</a>
</span>
<a id="HarmonyLib_CodeMatch__ctor_" data-uid="HarmonyLib.CodeMatch.#ctor*"></a>
<h4 id="HarmonyLib_CodeMatch__ctor_System_Func_HarmonyLib_CodeInstruction_System_Boolean__System_String_" data-uid="HarmonyLib.CodeMatch.#ctor(System.Func{HarmonyLib.CodeInstruction,System.Boolean},System.String)">CodeMatch(Func&lt;CodeInstruction, Boolean&gt;, String)</h4>
Expand Down Expand Up @@ -235,6 +235,86 @@ <h5 class="parameters">Parameters</h5>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">name</span></td>
<td><p>An optional name</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_CodeMatch__ctor_System_Linq_Expressions_Expression_System_Action__System_String_.md&amp;value=---%0Auid%3A%20HarmonyLib.CodeMatch.%23ctor(System.Linq.Expressions.Expression%7BSystem.Action%7D%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/Tools/CodeMatch.cs/#L60">View Source</a>
</span>
<a id="HarmonyLib_CodeMatch__ctor_" data-uid="HarmonyLib.CodeMatch.#ctor*"></a>
<h4 id="HarmonyLib_CodeMatch__ctor_System_Linq_Expressions_Expression_System_Action__System_String_" data-uid="HarmonyLib.CodeMatch.#ctor(System.Linq.Expressions.Expression{System.Action},System.String)">CodeMatch(Expression&lt;Action&gt;, String)</h4>
<div class="markdown level1 summary"><p>Creates a code match that calls a method</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public CodeMatch(Expression&lt;Action&gt; expression, string name = null)</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.Linq.Expressions.Expression</span>&lt;<span class="xref">System.Action</span>&gt;</td>
<td><span class="parametername">expression</span></td>
<td><p>The lambda expression using the method</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">name</span></td>
<td><p>The optional name</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_CodeMatch__ctor_System_Linq_Expressions_LambdaExpression_System_String_.md&amp;value=---%0Auid%3A%20HarmonyLib.CodeMatch.%23ctor(System.Linq.Expressions.LambdaExpression%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/Tools/CodeMatch.cs/#L75">View Source</a>
</span>
<a id="HarmonyLib_CodeMatch__ctor_" data-uid="HarmonyLib.CodeMatch.#ctor*"></a>
<h4 id="HarmonyLib_CodeMatch__ctor_System_Linq_Expressions_LambdaExpression_System_String_" data-uid="HarmonyLib.CodeMatch.#ctor(System.Linq.Expressions.LambdaExpression,System.String)">CodeMatch(LambdaExpression, String)</h4>
<div class="markdown level1 summary"><p>Creates a code match that calls a method</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public CodeMatch(LambdaExpression expression, string name = null)</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.Linq.Expressions.LambdaExpression</span></td>
<td><span class="parametername">expression</span></td>
<td><p>The lambda expression using the method</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">name</span></td>
<td><p>The optional name</p>
</td>
</tr>
</tbody>
Expand All @@ -244,7 +324,7 @@ <h5 class="parameters">Parameters</h5>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_CodeMatch__ctor_System_Nullable_System_Reflection_Emit_OpCode__System_Object_System_String_.md&amp;value=---%0Auid%3A%20HarmonyLib.CodeMatch.%23ctor(System.Nullable%7BSystem.Reflection.Emit.OpCode%7D%2CSystem.Object%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/Tools/CodeMatch.cs/#L42">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Tools/CodeMatch.cs/#L43">View Source</a>
</span>
<a id="HarmonyLib_CodeMatch__ctor_" data-uid="HarmonyLib.CodeMatch.#ctor*"></a>
<h4 id="HarmonyLib_CodeMatch__ctor_System_Nullable_System_Reflection_Emit_OpCode__System_Object_System_String_" data-uid="HarmonyLib.CodeMatch.#ctor(System.Nullable{System.Reflection.Emit.OpCode},System.Object,System.String)">CodeMatch(Nullable&lt;OpCode&gt;, Object, String)</h4>
Expand Down Expand Up @@ -292,7 +372,7 @@ <h3 id="fields">Fields
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_CodeMatch_jumpsFrom.md&amp;value=---%0Auid%3A%20HarmonyLib.CodeMatch.jumpsFrom%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/Tools/CodeMatch.cs/#L21">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Tools/CodeMatch.cs/#L22">View Source</a>
</span>
<h4 id="HarmonyLib_CodeMatch_jumpsFrom" data-uid="HarmonyLib.CodeMatch.jumpsFrom">jumpsFrom</h4>
<div class="markdown level1 summary"><p>The jumps from the match</p>
Expand Down Expand Up @@ -322,7 +402,7 @@ <h5 class="fieldValue">Field Value</h5>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_CodeMatch_jumpsTo.md&amp;value=---%0Auid%3A%20HarmonyLib.CodeMatch.jumpsTo%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/Tools/CodeMatch.cs/#L24">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Tools/CodeMatch.cs/#L25">View Source</a>
</span>
<h4 id="HarmonyLib_CodeMatch_jumpsTo" data-uid="HarmonyLib.CodeMatch.jumpsTo">jumpsTo</h4>
<div class="markdown level1 summary"><p>The jumps to the match</p>
Expand Down Expand Up @@ -352,7 +432,7 @@ <h5 class="fieldValue">Field Value</h5>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_CodeMatch_name.md&amp;value=---%0Auid%3A%20HarmonyLib.CodeMatch.name%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/Tools/CodeMatch.cs/#L12">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Tools/CodeMatch.cs/#L13">View Source</a>
</span>
<h4 id="HarmonyLib_CodeMatch_name" data-uid="HarmonyLib.CodeMatch.name">name</h4>
<div class="markdown level1 summary"><p>The name of the match</p>
Expand Down Expand Up @@ -382,7 +462,7 @@ <h5 class="fieldValue">Field Value</h5>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_CodeMatch_opcodes.md&amp;value=---%0Auid%3A%20HarmonyLib.CodeMatch.opcodes%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/Tools/CodeMatch.cs/#L15">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Tools/CodeMatch.cs/#L16">View Source</a>
</span>
<h4 id="HarmonyLib_CodeMatch_opcodes" data-uid="HarmonyLib.CodeMatch.opcodes">opcodes</h4>
<div class="markdown level1 summary"><p>The matched opcodes</p>
Expand Down Expand Up @@ -412,7 +492,7 @@ <h5 class="fieldValue">Field Value</h5>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_CodeMatch_operands.md&amp;value=---%0Auid%3A%20HarmonyLib.CodeMatch.operands%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/Tools/CodeMatch.cs/#L18">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Tools/CodeMatch.cs/#L19">View Source</a>
</span>
<h4 id="HarmonyLib_CodeMatch_operands" data-uid="HarmonyLib.CodeMatch.operands">operands</h4>
<div class="markdown level1 summary"><p>The matched operands</p>
Expand Down Expand Up @@ -442,7 +522,7 @@ <h5 class="fieldValue">Field Value</h5>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_CodeMatch_predicate.md&amp;value=---%0Auid%3A%20HarmonyLib.CodeMatch.predicate%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/Tools/CodeMatch.cs/#L27">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Tools/CodeMatch.cs/#L28">View Source</a>
</span>
<h4 id="HarmonyLib_CodeMatch_predicate" data-uid="HarmonyLib.CodeMatch.predicate">predicate</h4>
<div class="markdown level1 summary"><p>The match predicate</p>
Expand Down Expand Up @@ -474,7 +554,7 @@ <h3 id="methods">Methods
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_CodeMatch_ToString.md&amp;value=---%0Auid%3A%20HarmonyLib.CodeMatch.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/Tools/CodeMatch.cs/#L100">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Tools/CodeMatch.cs/#L131">View Source</a>
</span>
<a id="HarmonyLib_CodeMatch_ToString_" data-uid="HarmonyLib.CodeMatch.ToString*"></a>
<h4 id="HarmonyLib_CodeMatch_ToString" data-uid="HarmonyLib.CodeMatch.ToString">ToString()</h4>
Expand Down Expand Up @@ -593,7 +673,7 @@ <h3 id="extensionmethods">Extension Methods</h3>
<a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_CodeMatch.md&amp;value=---%0Auid%3A%20HarmonyLib.CodeMatch%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/CodeMatch.cs/#L9" class="contribution-link">View Source</a>
<a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Tools/CodeMatch.cs/#L10" class="contribution-link">View Source</a>
</li>
</ul>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/manifest.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@
"output": {
".html": {
"relative_path": "api/HarmonyLib.CodeMatch.html",
"hash": "txEXQTQ4CQwHfrw1aywA3TBYBC8wbamtYhoMN5RA4dY="
"hash": "USa745h27o4TDia9y7YU3uuicavX88LnA4WOecAHQRw="
}
},
"is_incremental": false,
Expand Down
15 changes: 15 additions & 0 deletions docs/xrefmap.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1734,6 +1734,21 @@ references:
fullName.vb: HarmonyLib.CodeMatch.CodeMatch(System.Func(Of HarmonyLib.CodeInstruction, System.Boolean), System.String)
nameWithType: CodeMatch.CodeMatch(Func<CodeInstruction, Boolean>, String)
nameWithType.vb: CodeMatch.CodeMatch(Func(Of CodeInstruction, Boolean), String)
- uid: HarmonyLib.CodeMatch.#ctor(System.Linq.Expressions.Expression{System.Action},System.String)
name: CodeMatch(Expression<Action>, String)
href: api/HarmonyLib.CodeMatch.html#HarmonyLib_CodeMatch__ctor_System_Linq_Expressions_Expression_System_Action__System_String_
commentId: M:HarmonyLib.CodeMatch.#ctor(System.Linq.Expressions.Expression{System.Action},System.String)
name.vb: CodeMatch(Expression(Of Action), String)
fullName: HarmonyLib.CodeMatch.CodeMatch(System.Linq.Expressions.Expression<System.Action>, System.String)
fullName.vb: HarmonyLib.CodeMatch.CodeMatch(System.Linq.Expressions.Expression(Of System.Action), System.String)
nameWithType: CodeMatch.CodeMatch(Expression<Action>, String)
nameWithType.vb: CodeMatch.CodeMatch(Expression(Of Action), String)
- uid: HarmonyLib.CodeMatch.#ctor(System.Linq.Expressions.LambdaExpression,System.String)
name: CodeMatch(LambdaExpression, String)
href: api/HarmonyLib.CodeMatch.html#HarmonyLib_CodeMatch__ctor_System_Linq_Expressions_LambdaExpression_System_String_
commentId: M:HarmonyLib.CodeMatch.#ctor(System.Linq.Expressions.LambdaExpression,System.String)
fullName: HarmonyLib.CodeMatch.CodeMatch(System.Linq.Expressions.LambdaExpression, System.String)
nameWithType: CodeMatch.CodeMatch(LambdaExpression, String)
- uid: HarmonyLib.CodeMatch.#ctor(System.Nullable{System.Reflection.Emit.OpCode},System.Object,System.String)
name: CodeMatch(Nullable<OpCode>, Object, String)
href: api/HarmonyLib.CodeMatch.html#HarmonyLib_CodeMatch__ctor_System_Nullable_System_Reflection_Emit_OpCode__System_Object_System_String_
Expand Down

0 comments on commit 5a48778

Please sign in to comment.