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

docs: regenerate

Browse source
This commit is contained in:
goat 2021-04-06 00:41:38 +02:00
parent 857a693842
commit aceb905c82
491 changed files with 201855 additions and 15575 deletions
Download patch file Download diff file Expand all files Collapse all files

77
docs/api/Dalamud.Dalamud.html
View file

@ -73,7 +73,8 @@
<h1 id="Dalamud_Dalamud" data-uid="Dalamud.Dalamud" class="text-break">Class Dalamud
</h1>
<div class="markdown level0 summary"></div>
<div class="markdown level0 summary"><p>The main Dalamud class containing all subsystems.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
@ -121,11 +122,12 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Dalamud__ctor_Dalamud_DalamudStartInfo_Serilog_Core_LoggingLevelSwitch_System_Threading_ManualResetEvent_.md&amp;value=---%0Auid%3A%20Dalamud.Dalamud.%23ctor(Dalamud.DalamudStartInfo%2CSerilog.Core.LoggingLevelSwitch%2CSystem.Threading.ManualResetEvent)%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/Dalamud.cs/#L167">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Dalamud.cs/#L42">View Source</a>
</span>
<a id="Dalamud_Dalamud__ctor_" data-uid="Dalamud.Dalamud.#ctor*"></a>
<h4 id="Dalamud_Dalamud__ctor_Dalamud_DalamudStartInfo_Serilog_Core_LoggingLevelSwitch_System_Threading_ManualResetEvent_" data-uid="Dalamud.Dalamud.#ctor(Dalamud.DalamudStartInfo,Serilog.Core.LoggingLevelSwitch,System.Threading.ManualResetEvent)">Dalamud(DalamudStartInfo, LoggingLevelSwitch, ManualResetEvent)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Dalamud.Dalamud.html">Dalamud</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -144,50 +146,20 @@
<tr>
<td><a class="xref" href="Dalamud.DalamudStartInfo.html">DalamudStartInfo</a></td>
<td><span class="parametername">info</span></td>
<td></td>
<td><p>DalamudStartInfo instance.</p>
</td>
</tr>
<tr>
<td><span class="xref">Serilog.Core.LoggingLevelSwitch</span></td>
<td><span class="parametername">loggingLevelSwitch</span></td>
<td></td>
<td><p>LoggingLevelSwitch to control Serilog level.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Threading.ManualResetEvent</span></td>
<td><span class="parametername">finishSignal</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Dalamud_ClientState.md&amp;value=---%0Auid%3A%20Dalamud.Dalamud.ClientState%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/Dalamud.cs/#L56">View Source</a>
</span>
<a id="Dalamud_Dalamud_ClientState_" data-uid="Dalamud.Dalamud.ClientState*"></a>
<h4 id="Dalamud_Dalamud_ClientState" data-uid="Dalamud.Dalamud.ClientState">ClientState</h4>
<div class="markdown level1 summary"><p>ClientState subsystem</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ClientState ClientState { get; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Dalamud.Game.ClientState.ClientState.html">ClientState</a></td>
<td></td>
<td><p>Signal signalling shutdown.</p>
</td>
</tr>
</tbody>
</table>
@ -198,11 +170,12 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Dalamud_Dispose.md&amp;value=---%0Auid%3A%20Dalamud.Dalamud.Dispose%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/Dalamud.cs/#L281">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Dalamud.cs/#L357">View Source</a>
</span>
<a id="Dalamud_Dalamud_Dispose_" data-uid="Dalamud.Dalamud.Dispose*"></a>
<h4 id="Dalamud_Dalamud_Dispose" data-uid="Dalamud.Dalamud.Dispose">Dispose()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Dispose Dalamud subsystems.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -213,11 +186,12 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Dalamud_Start.md&amp;value=---%0Auid%3A%20Dalamud.Dalamud.Start%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/Dalamud.cs/#L180">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Dalamud.cs/#L185">View Source</a>
</span>
<a id="Dalamud_Dalamud_Start_" data-uid="Dalamud.Dalamud.Start*"></a>
<h4 id="Dalamud_Dalamud_Start" data-uid="Dalamud.Dalamud.Start">Start()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Start and initialize Dalamud subsystems.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -228,11 +202,12 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Dalamud_Unload.md&amp;value=---%0Auid%3A%20Dalamud.Dalamud.Unload%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/Dalamud.cs/#L268">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Dalamud.cs/#L332">View Source</a>
</span>
<a id="Dalamud_Dalamud_Unload_" data-uid="Dalamud.Dalamud.Unload*"></a>
<h4 id="Dalamud_Dalamud_Unload" data-uid="Dalamud.Dalamud.Unload">Unload()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Queue an unload of Dalamud when it gets the chance.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -243,11 +218,12 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Dalamud_WaitForUnload.md&amp;value=---%0Auid%3A%20Dalamud.Dalamud.WaitForUnload%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/Dalamud.cs/#L273">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Dalamud.cs/#L341">View Source</a>
</span>
<a id="Dalamud_Dalamud_WaitForUnload_" data-uid="Dalamud.Dalamud.WaitForUnload*"></a>
<h4 id="Dalamud_Dalamud_WaitForUnload" data-uid="Dalamud.Dalamud.WaitForUnload">WaitForUnload()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Wait for an unload request to start.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -258,11 +234,12 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Dalamud_WaitForUnloadFinish.md&amp;value=---%0Auid%3A%20Dalamud.Dalamud.WaitForUnloadFinish%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/Dalamud.cs/#L277">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Dalamud.cs/#L349">View Source</a>
</span>
<a id="Dalamud_Dalamud_WaitForUnloadFinish_" data-uid="Dalamud.Dalamud.WaitForUnloadFinish*"></a>
<h4 id="Dalamud_Dalamud_WaitForUnloadFinish" data-uid="Dalamud.Dalamud.WaitForUnloadFinish">WaitForUnloadFinish()</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Wait for a queued unload to be finalized.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -283,7 +260,7 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Dalamud.md&amp;value=---%0Auid%3A%20Dalamud.Dalamud%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/Dalamud.cs/#L29" class="contribution-link">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Dalamud.cs/#L24" class="contribution-link">View Source</a>
</li>
</ul>
</div>