Update documentation

pardeike · Feb 8, 2020 · 5121f5e · 5121f5e
1 parent 69af164
commit 5121f5e
Show file tree

Hide file tree

Showing 7 changed files with 473 additions and 15 deletions.
diff --git a/docs/api/HarmonyLib.Harmony.html b/docs/api/HarmonyLib.Harmony.html
@@ -565,7 +565,7 @@ <h4 id="HarmonyLib_Harmony_ReversePatch_System_Reflection_MethodBase_HarmonyLib_
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public MethodInfo ReversePatch(MethodBase original, HarmonyMethod standin, MethodInfo transpiler = null)</code></pre>
+    <pre><code class="lang-csharp hljs">public static MethodInfo ReversePatch(MethodBase original, HarmonyMethod standin, MethodInfo transpiler = null)</code></pre>
   </div>
   <h5 class="parameters">Parameters</h5>
   <table class="table table-bordered table-striped table-condensed">

diff --git a/docs/api/HarmonyLib.HarmonyException.html b/docs/api/HarmonyLib.HarmonyException.html
diff --git a/docs/api/HarmonyLib.PatchClassProcessor.html b/docs/api/HarmonyLib.PatchClassProcessor.html
@@ -118,7 +118,7 @@ <h3 id="constructors">Constructors
     <a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_PatchClassProcessor__ctor_HarmonyLib_Harmony_System_Type_.md&amp;value=---%0Auid%3A%20HarmonyLib.PatchClassProcessor.%23ctor(HarmonyLib.Harmony%2CSystem.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/PatchClassProcessor.cs/#L54">View Source</a>
+    <a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/PatchClassProcessor.cs/#L30">View Source</a>
   </span>
   <a id="HarmonyLib_PatchClassProcessor__ctor_" data-uid="HarmonyLib.PatchClassProcessor.#ctor*"></a>
   <h4 id="HarmonyLib_PatchClassProcessor__ctor_HarmonyLib_Harmony_System_Type_" data-uid="HarmonyLib.PatchClassProcessor.#ctor(HarmonyLib.Harmony,System.Type)">PatchClassProcessor(Harmony, Type)</h4>
@@ -160,7 +160,7 @@ <h3 id="methods">Methods
     <a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_PatchClassProcessor_Patch.md&amp;value=---%0Auid%3A%20HarmonyLib.PatchClassProcessor.Patch%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/#L91">View Source</a>
+    <a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/PatchClassProcessor.cs/#L67">View Source</a>
   </span>
   <a id="HarmonyLib_PatchClassProcessor_Patch_" data-uid="HarmonyLib.PatchClassProcessor.Patch*"></a>
   <h4 id="HarmonyLib_PatchClassProcessor_Patch" data-uid="HarmonyLib.PatchClassProcessor.Patch">Patch()</h4>
@@ -198,7 +198,7 @@ <h5 class="returns">Returns</h5>
                     <a href="https://github.com/pardeike/Harmony/new/master/apiSpec/new?filename=HarmonyLib_PatchClassProcessor.md&amp;value=---%0Auid%3A%20HarmonyLib.PatchClassProcessor%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/Public/PatchClassProcessor.cs/#L33" class="contribution-link">View Source</a>
+                    <a href="https://github.com/pardeike/Harmony/blob/master/Harmony/Public/PatchClassProcessor.cs/#L9" class="contribution-link">View Source</a>
                   </li>
                 </ul>
               </div>

diff --git a/docs/api/HarmonyLib.html b/docs/api/HarmonyLib.html
@@ -127,6 +127,9 @@ <h4><a class="xref" href="HarmonyLib.HarmonyCleanup.html">HarmonyCleanup</a></h4
 </section>
       <h4><a class="xref" href="HarmonyLib.HarmonyDebug.html">HarmonyDebug</a></h4>
       <section><p>A Harmony annotation</p>
+</section>
+      <h4><a class="xref" href="HarmonyLib.HarmonyException.html">HarmonyException</a></h4>
+      <section><p>HarmonyException wraps IL compile errors (only mono) containing detailed information about the failure</p>
 </section>
       <h4><a class="xref" href="HarmonyLib.HarmonyFinalizer.html">HarmonyFinalizer</a></h4>
       <section><p>Specifies the Finalizer function in a patch class</p>

diff --git a/docs/api/toc.html b/docs/api/toc.html
@@ -86,6 +86,9 @@
                           <li>
                               <a href="HarmonyLib.HarmonyDebug.html" name="" title="HarmonyDebug">HarmonyDebug</a>
                           </li>
+                          <li>
+                              <a href="HarmonyLib.HarmonyException.html" name="" title="HarmonyException">HarmonyException</a>
+                          </li>
                           <li>
                               <a href="HarmonyLib.HarmonyFinalizer.html" name="" title="HarmonyFinalizer">HarmonyFinalizer</a>
                           </li>

diff --git a/docs/manifest.json b/docs/manifest.json
@@ -201,7 +201,7 @@
       "output": {
         ".html": {
           "relative_path": "api/HarmonyLib.Harmony.html",
-          "hash": "6ssbmHSz4GuFHjNbGY828g=="
+          "hash": "d1IeXHO12f8kSdDyKpZ2Iw=="
         }
       },
       "is_incremental": false,
@@ -279,6 +279,18 @@
       "is_incremental": false,
       "version": ""
     },
+    {
+      "type": "ManagedReference",
+      "source_relative_path": "api/HarmonyLib.HarmonyException.yml",
+      "output": {
+        ".html": {
+          "relative_path": "api/HarmonyLib.HarmonyException.html",
+          "hash": "3WSPRpXMqGjXZKZYIRcfZg=="
+        }
+      },
+      "is_incremental": false,
+      "version": ""
+    },
     {
       "type": "ManagedReference",
       "source_relative_path": "api/HarmonyLib.HarmonyFinalizer.yml",
@@ -549,7 +561,7 @@
       "output": {
         ".html": {
           "relative_path": "api/HarmonyLib.PatchClassProcessor.html",
-          "hash": "DbdHLUmTPMXXrODbdRVSqQ=="
+          "hash": "F54kZXX8cJsGhYiIPNjRZw=="
         }
       },
       "is_incremental": false,
@@ -681,7 +693,7 @@
       "output": {
         ".html": {
           "relative_path": "api/HarmonyLib.html",
-          "hash": "I+ytDjNOelRPePF+nwW78g=="
+          "hash": "t6HwYbmqFoQMtl678BZIfg=="
         }
       },
       "is_incremental": false,
@@ -705,7 +717,7 @@
       "output": {
         ".html": {
           "relative_path": "api/toc.html",
-          "hash": "J7j0qb+xPfZCpUuieMVWAw=="
+          "hash": "mO5rimXWL+UH9dxUZctRjA=="
         }
       },
       "is_incremental": false,
@@ -974,9 +986,9 @@
         "full_build_reason_code": "NoAvailableBuildCache"
       },
       "processors": {
-        "TocDocumentProcessor": {
+        "ResourceDocumentProcessor": {
           "can_incremental": false,
-          "details": "Processor TocDocumentProcessor cannot support incremental build because the processor doesn't implement ISupportIncrementalDocumentProcessor interface.",
+          "details": "Processor ResourceDocumentProcessor cannot support incremental build because the processor doesn't implement ISupportIncrementalDocumentProcessor interface.",
           "incrementalPhase": "build",
           "total_file_count": 0,
           "skipped_file_count": 0
@@ -987,17 +999,17 @@
           "total_file_count": 16,
           "skipped_file_count": 0
         },
-        "ManagedReferenceDocumentProcessor": {
+        "TocDocumentProcessor": {
           "can_incremental": false,
+          "details": "Processor TocDocumentProcessor cannot support incremental build because the processor doesn't implement ISupportIncrementalDocumentProcessor interface.",
           "incrementalPhase": "build",
-          "total_file_count": 57,
+          "total_file_count": 0,
           "skipped_file_count": 0
         },
-        "ResourceDocumentProcessor": {
+        "ManagedReferenceDocumentProcessor": {
           "can_incremental": false,
-          "details": "Processor ResourceDocumentProcessor cannot support incremental build because the processor doesn't implement ISupportIncrementalDocumentProcessor interface.",
           "incrementalPhase": "build",
-          "total_file_count": 0,
+          "total_file_count": 58,
           "skipped_file_count": 0
         }
       }

diff --git a/docs/xrefmap.yml b/docs/xrefmap.yml
@@ -2578,6 +2578,77 @@ references:
   isSpec: "True"
   fullName: HarmonyLib.HarmonyDebug.HarmonyDebug
   nameWithType: HarmonyDebug.HarmonyDebug
+- uid: HarmonyLib.HarmonyException
+  name: HarmonyException
+  href: api/HarmonyLib.HarmonyException.html
+  commentId: T:HarmonyLib.HarmonyException
+  fullName: HarmonyLib.HarmonyException
+  nameWithType: HarmonyException
+- uid: HarmonyLib.HarmonyException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)
+  name: HarmonyException(SerializationInfo, StreamingContext)
+  href: api/HarmonyLib.HarmonyException.html#HarmonyLib_HarmonyException__ctor_System_Runtime_Serialization_SerializationInfo_System_Runtime_Serialization_StreamingContext_
+  commentId: M:HarmonyLib.HarmonyException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)
+  fullName: HarmonyLib.HarmonyException.HarmonyException(System.Runtime.Serialization.SerializationInfo, System.Runtime.Serialization.StreamingContext)
+  nameWithType: HarmonyException.HarmonyException(SerializationInfo, StreamingContext)
+- uid: HarmonyLib.HarmonyException.#ctor*
+  name: HarmonyException
+  href: api/HarmonyLib.HarmonyException.html#HarmonyLib_HarmonyException__ctor_
+  commentId: Overload:HarmonyLib.HarmonyException.#ctor
+  isSpec: "True"
+  fullName: HarmonyLib.HarmonyException.HarmonyException
+  nameWithType: HarmonyException.HarmonyException
+- uid: HarmonyLib.HarmonyException.GetErrorIndex
+  name: GetErrorIndex()
+  href: api/HarmonyLib.HarmonyException.html#HarmonyLib_HarmonyException_GetErrorIndex
+  commentId: M:HarmonyLib.HarmonyException.GetErrorIndex
+  fullName: HarmonyLib.HarmonyException.GetErrorIndex()
+  nameWithType: HarmonyException.GetErrorIndex()
+- uid: HarmonyLib.HarmonyException.GetErrorIndex*
+  name: GetErrorIndex
+  href: api/HarmonyLib.HarmonyException.html#HarmonyLib_HarmonyException_GetErrorIndex_
+  commentId: Overload:HarmonyLib.HarmonyException.GetErrorIndex
+  isSpec: "True"
+  fullName: HarmonyLib.HarmonyException.GetErrorIndex
+  nameWithType: HarmonyException.GetErrorIndex
+- uid: HarmonyLib.HarmonyException.GetErrorOffset
+  name: GetErrorOffset()
+  href: api/HarmonyLib.HarmonyException.html#HarmonyLib_HarmonyException_GetErrorOffset
+  commentId: M:HarmonyLib.HarmonyException.GetErrorOffset
+  fullName: HarmonyLib.HarmonyException.GetErrorOffset()
+  nameWithType: HarmonyException.GetErrorOffset()
+- uid: HarmonyLib.HarmonyException.GetErrorOffset*
+  name: GetErrorOffset
+  href: api/HarmonyLib.HarmonyException.html#HarmonyLib_HarmonyException_GetErrorOffset_
+  commentId: Overload:HarmonyLib.HarmonyException.GetErrorOffset
+  isSpec: "True"
+  fullName: HarmonyLib.HarmonyException.GetErrorOffset
+  nameWithType: HarmonyException.GetErrorOffset
+- uid: HarmonyLib.HarmonyException.GetInstructions
+  name: GetInstructions()
+  href: api/HarmonyLib.HarmonyException.html#HarmonyLib_HarmonyException_GetInstructions
+  commentId: M:HarmonyLib.HarmonyException.GetInstructions
+  fullName: HarmonyLib.HarmonyException.GetInstructions()
+  nameWithType: HarmonyException.GetInstructions()
+- uid: HarmonyLib.HarmonyException.GetInstructions*
+  name: GetInstructions
+  href: api/HarmonyLib.HarmonyException.html#HarmonyLib_HarmonyException_GetInstructions_
+  commentId: Overload:HarmonyLib.HarmonyException.GetInstructions
+  isSpec: "True"
+  fullName: HarmonyLib.HarmonyException.GetInstructions
+  nameWithType: HarmonyException.GetInstructions
+- uid: HarmonyLib.HarmonyException.GetInstructionsWithOffsets
+  name: GetInstructionsWithOffsets()
+  href: api/HarmonyLib.HarmonyException.html#HarmonyLib_HarmonyException_GetInstructionsWithOffsets
+  commentId: M:HarmonyLib.HarmonyException.GetInstructionsWithOffsets
+  fullName: HarmonyLib.HarmonyException.GetInstructionsWithOffsets()
+  nameWithType: HarmonyException.GetInstructionsWithOffsets()
+- uid: HarmonyLib.HarmonyException.GetInstructionsWithOffsets*
+  name: GetInstructionsWithOffsets
+  href: api/HarmonyLib.HarmonyException.html#HarmonyLib_HarmonyException_GetInstructionsWithOffsets_
+  commentId: Overload:HarmonyLib.HarmonyException.GetInstructionsWithOffsets
+  isSpec: "True"
+  fullName: HarmonyLib.HarmonyException.GetInstructionsWithOffsets
+  nameWithType: HarmonyException.GetInstructionsWithOffsets
 - uid: HarmonyLib.HarmonyFinalizer
   name: HarmonyFinalizer
   href: api/HarmonyLib.HarmonyFinalizer.html