ToxicMushroom/Dalamud
1
0
Fork 0
mirror of https://github.com/goatcorp/Dalamud.git synced 2025-12-13 12:14:16 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

docs: regenerate

Browse source
This commit is contained in:
goat 2021-04-25 15:20:12 +02:00
parent 62e44bf30f
commit 392376b3fc
No known key found for this signature in database
GPG key ID: F18F057873895461
106 changed files with 4881 additions and 2447 deletions
Download patch file Download diff file Expand all files Collapse all files

169
docs/api/Dalamud.Util.html
View file

@ -118,7 +118,7 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Util_AssemblyVersion.md&amp;value=---%0Auid%3A%20Dalamud.Util.AssemblyVersion%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/goatcorp/Dalamud/blob/master/Dalamud/Util.cs/#L19">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Util.cs/#L26">View Source</a>
</span>
<a id="Dalamud_Util_AssemblyVersion_" data-uid="Dalamud.Util.AssemblyVersion*"></a>
<h4 id="Dalamud_Util_AssemblyVersion" data-uid="Dalamud.Util.AssemblyVersion">AssemblyVersion</h4>
@ -151,7 +151,7 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Util_ByteArrayToHex_System_Byte___System_Int32_System_Int32_.md&amp;value=---%0Auid%3A%20Dalamud.Util.ByteArrayToHex(System.Byte%5B%5D%2CSystem.Int32%2CSystem.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/goatcorp/Dalamud/blob/master/Dalamud/Util.cs/#L40">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Util.cs/#L65">View Source</a>
</span>
<a id="Dalamud_Util_ByteArrayToHex_" data-uid="Dalamud.Util.ByteArrayToHex*"></a>
<h4 id="Dalamud_Util_ByteArrayToHex_System_Byte___System_Int32_System_Int32_" data-uid="Dalamud.Util.ByteArrayToHex(System.Byte[],System.Int32,System.Int32)">ByteArrayToHex(Byte[], Int32, Int32)</h4>
@ -213,7 +213,7 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Util_DumpMemory_System_IntPtr_System_Int32_.md&amp;value=---%0Auid%3A%20Dalamud.Util.DumpMemory(System.IntPtr%2CSystem.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/goatcorp/Dalamud/blob/master/Dalamud/Util.cs/#L26">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Util.cs/#L51">View Source</a>
</span>
<a id="Dalamud_Util_DumpMemory_" data-uid="Dalamud.Util.DumpMemory*"></a>
<h4 id="Dalamud_Util_DumpMemory_System_IntPtr_System_Int32_" data-uid="Dalamud.Util.DumpMemory(System.IntPtr,System.Int32)">DumpMemory(IntPtr, Int32)</h4>
@ -244,6 +244,167 @@
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">len</span></td>
<td><p>The length to read.</p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Util_Fatal_System_String_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Util.Fatal(System.String%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/goatcorp/Dalamud/blob/master/Dalamud/Util.cs/#L154">View Source</a>
</span>
<a id="Dalamud_Util_Fatal_" data-uid="Dalamud.Util.Fatal*"></a>
<h4 id="Dalamud_Util_Fatal_System_String_System_String_" data-uid="Dalamud.Util.Fatal(System.String,System.String)">Fatal(String, String)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void Fatal(string message, string caption)</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">message</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">caption</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Util_GetGitHash.md&amp;value=---%0Auid%3A%20Dalamud.Util.GetGitHash%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/goatcorp/Dalamud/blob/master/Dalamud/Util.cs/#L33">View Source</a>
</span>
<a id="Dalamud_Util_GetGitHash_" data-uid="Dalamud.Util.GetGitHash*"></a>
<h4 id="Dalamud_Util_GetGitHash" data-uid="Dalamud.Util.GetGitHash">GetGitHash()</h4>
<div class="markdown level1 summary"><p>Gets the git hash value from the assembly
or null if it cannot be found.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static string GetGitHash()</code></pre>
</div>
<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><span class="xref">System.String</span></td>
<td><p>The git hash of the assembly.</p>
</td>
</tr>
</tbody>
</table>
<a id="Dalamud_Util_MessageBox_" data-uid="Dalamud.Util.MessageBox*"></a>
<h4 id="Dalamud_Util_MessageBox_System_IntPtr_System_String_System_String_System_UInt32_" data-uid="Dalamud.Util.MessageBox(System.IntPtr,System.String,System.String,System.UInt32)">MessageBox(IntPtr, String, String, UInt32)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static int MessageBox(IntPtr hWnd, string text, string caption, uint type)</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.IntPtr</span></td>
<td><span class="parametername">hWnd</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">text</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">caption</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.UInt32</span></td>
<td><span class="parametername">type</span></td>
<td></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><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Util_ShowObject_System_Object_.md&amp;value=---%0Auid%3A%20Dalamud.Util.ShowObject(System.Object)%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/goatcorp/Dalamud/blob/master/Dalamud/Util.cs/#L128">View Source</a>
</span>
<a id="Dalamud_Util_ShowObject_" data-uid="Dalamud.Util.ShowObject*"></a>
<h4 id="Dalamud_Util_ShowObject_System_Object_" data-uid="Dalamud.Util.ShowObject(System.Object)">ShowObject(Object)</h4>
<div class="markdown level1 summary"><p>Show all properties and fields of the provided object via ImGui.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void ShowObject(object obj)</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.Object</span></td>
<td><span class="parametername">obj</span></td>
<td><p>The object to show.</p>
</td>
</tr>
</tbody>
@ -259,7 +420,7 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Util.md&amp;value=---%0Auid%3A%20Dalamud.Util%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/goatcorp/Dalamud/blob/master/Dalamud/Util.cs/#L14" class="contribution-link">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Util.cs/#L19" class="contribution-link">View Source</a>
</li>
</ul>
</div>