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

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

71
docs/api/Dalamud.Configuration.PluginConfigurations.html
View file

@ -73,7 +73,8 @@
<h1 id="Dalamud_Configuration_PluginConfigurations" data-uid="Dalamud.Configuration.PluginConfigurations" class="text-break">Class PluginConfigurations
</h1>
<div class="markdown level0 summary"></div>
<div class="markdown level0 summary"><p>Configuration to store settings for a dalamud plugin.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
@ -117,11 +118,12 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Configuration_PluginConfigurations__ctor_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Configuration.PluginConfigurations.%23ctor(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/goatcorp/Dalamud/blob/master/Dalamud/Configuration/PluginConfigurations.cs/#L14">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Configuration/PluginConfigurations.cs/#L18">View Source</a>
</span>
<a id="Dalamud_Configuration_PluginConfigurations__ctor_" data-uid="Dalamud.Configuration.PluginConfigurations.#ctor*"></a>
<h4 id="Dalamud_Configuration_PluginConfigurations__ctor_System_String_" data-uid="Dalamud.Configuration.PluginConfigurations.#ctor(System.String)">PluginConfigurations(String)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Dalamud.Configuration.PluginConfigurations.html">PluginConfigurations</a> class.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -140,7 +142,8 @@
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">storageFolder</span></td>
<td></td>
<td><p>Directory for storage of plugin configuration files.</p>
</td>
</tr>
</tbody>
</table>
@ -151,7 +154,7 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Configuration_PluginConfigurations_GetConfigFile_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Configuration.PluginConfigurations.GetConfigFile(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/goatcorp/Dalamud/blob/master/Dalamud/Configuration/PluginConfigurations.cs/#L78">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Configuration/PluginConfigurations.cs/#L111">View Source</a>
</span>
<a id="Dalamud_Configuration_PluginConfigurations_GetConfigFile_" data-uid="Dalamud.Configuration.PluginConfigurations.GetConfigFile*"></a>
<h4 id="Dalamud_Configuration_PluginConfigurations_GetConfigFile_System_String_" data-uid="Dalamud.Configuration.PluginConfigurations.GetConfigFile(System.String)">GetConfigFile(String)</h4>
@ -191,7 +194,7 @@
<tbody>
<tr>
<td><span class="xref">System.IO.FileInfo</span></td>
<td><p>FileInfo of the config file</p>
<td><p>FileInfo of the config file.</p>
</td>
</tr>
</tbody>
@ -201,11 +204,12 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Configuration_PluginConfigurations_GetDirectory_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Configuration.PluginConfigurations.GetDirectory(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/goatcorp/Dalamud/blob/master/Dalamud/Configuration/PluginConfigurations.cs/#L45">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Configuration/PluginConfigurations.cs/#L69">View Source</a>
</span>
<a id="Dalamud_Configuration_PluginConfigurations_GetDirectory_" data-uid="Dalamud.Configuration.PluginConfigurations.GetDirectory*"></a>
<h4 id="Dalamud_Configuration_PluginConfigurations_GetDirectory_System_String_" data-uid="Dalamud.Configuration.PluginConfigurations.GetDirectory(System.String)">GetDirectory(String)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Get plugin directory.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -224,7 +228,8 @@
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">pluginName</span></td>
<td></td>
<td><p>Plugin name.</p>
</td>
</tr>
</tbody>
</table>
@ -239,7 +244,8 @@
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td></td>
<td><p>Plugin directory path.</p>
</td>
</tr>
</tbody>
</table>
@ -248,11 +254,12 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Configuration_PluginConfigurations_Load_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Configuration.PluginConfigurations.Load(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/goatcorp/Dalamud/blob/master/Dalamud/Configuration/PluginConfigurations.cs/#L31">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Configuration/PluginConfigurations.cs/#L47">View Source</a>
</span>
<a id="Dalamud_Configuration_PluginConfigurations_Load_" data-uid="Dalamud.Configuration.PluginConfigurations.Load*"></a>
<h4 id="Dalamud_Configuration_PluginConfigurations_Load_System_String_" data-uid="Dalamud.Configuration.PluginConfigurations.Load(System.String)">Load(String)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Load plugin configuration.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -271,7 +278,8 @@
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">pluginName</span></td>
<td></td>
<td><p>Plugin name.</p>
</td>
</tr>
</tbody>
</table>
@ -286,7 +294,8 @@
<tbody>
<tr>
<td><a class="xref" href="Dalamud.Configuration.IPluginConfiguration.html">IPluginConfiguration</a></td>
<td></td>
<td><p>Plugin configuration.</p>
</td>
</tr>
</tbody>
</table>
@ -295,11 +304,15 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Configuration_PluginConfigurations_LoadForType__1_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Configuration.PluginConfigurations.LoadForType%60%601(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/goatcorp/Dalamud/blob/master/Dalamud/Configuration/PluginConfigurations.cs/#L61">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Configuration/PluginConfigurations.cs/#L96">View Source</a>
</span>
<a id="Dalamud_Configuration_PluginConfigurations_LoadForType_" data-uid="Dalamud.Configuration.PluginConfigurations.LoadForType*"></a>
<h4 id="Dalamud_Configuration_PluginConfigurations_LoadForType__1_System_String_" data-uid="Dalamud.Configuration.PluginConfigurations.LoadForType``1(System.String)">LoadForType&lt;T&gt;(String)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Load Plugin configuration. Parameterized deserialization.
Currently this is called via reflection from DalamudPluginInterface.GetPluginConfig().
Eventually there may be an additional pluginInterface method that can call this directly
without reflection - for now this is in support of the existing plugin api.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -319,7 +332,8 @@
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">pluginName</span></td>
<td></td>
<td><p>Plugin Name.</p>
</td>
</tr>
</tbody>
</table>
@ -334,7 +348,8 @@
<tbody>
<tr>
<td><span class="xref">T</span></td>
<td></td>
<td><p>Plugin Configuration.</p>
</td>
</tr>
</tbody>
</table>
@ -349,7 +364,8 @@
<tbody>
<tr>
<td><span class="parametername">T</span></td>
<td></td>
<td><p>Configuration Type.</p>
</td>
</tr>
</tbody>
</table>
@ -358,11 +374,16 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Configuration_PluginConfigurations_Save_Dalamud_Configuration_IPluginConfiguration_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Configuration.PluginConfigurations.Save(Dalamud.Configuration.IPluginConfiguration%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/Configuration/PluginConfigurations.cs/#L23">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Configuration/PluginConfigurations.cs/#L33">View Source</a>
</span>
<a id="Dalamud_Configuration_PluginConfigurations_Save_" data-uid="Dalamud.Configuration.PluginConfigurations.Save*"></a>
<h4 id="Dalamud_Configuration_PluginConfigurations_Save_Dalamud_Configuration_IPluginConfiguration_System_String_" data-uid="Dalamud.Configuration.PluginConfigurations.Save(Dalamud.Configuration.IPluginConfiguration,System.String)">Save(IPluginConfiguration, String)</h4>
<div class="markdown level1 summary"></div>
<div class="markdown level1 summary"><p>Save/Load plugin configuration.
NOTE: Save/Load are still using Type information for now,
despite LoadForType superseding Load and not requiring or using it.
It might be worth removing the Type info from Save, to strip it from all future saved configs,
and then Load() can probably be removed entirely.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
@ -381,12 +402,14 @@
<tr>
<td><a class="xref" href="Dalamud.Configuration.IPluginConfiguration.html">IPluginConfiguration</a></td>
<td><span class="parametername">config</span></td>
<td></td>
<td><p>Plugin configuration.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">pluginName</span></td>
<td></td>
<td><p>Plugin name.</p>
</td>
</tr>
</tbody>
</table>
@ -401,7 +424,7 @@
<a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Configuration_PluginConfigurations.md&amp;value=---%0Auid%3A%20Dalamud.Configuration.PluginConfigurations%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/Configuration/PluginConfigurations.cs/#L11" class="contribution-link">View Source</a>
<a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Configuration/PluginConfigurations.cs/#L10" class="contribution-link">View Source</a>
</li>
</ul>
</div>