mirror of
https://github.com/goatcorp/Dalamud.git
synced 2025-12-12 18:27:23 +01:00
docs: regenerate for log funcs
This commit is contained in:
goat
parent
3a688b9219
commit
9df15fcae4
6 changed files with 213 additions and 41 deletions
|
|
@ -383,6 +383,132 @@
|
|||
<tr>
|
||||
<td><a class="xref" href="Dalamud.Configuration.IPluginConfiguration.html">IPluginConfiguration</a></td>
|
||||
<td><p>A previously saved config or null if none was saved before.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_Log_System_String_System_Object___.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.Log(System.String%2CSystem.Object%5B%5D)%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/goaaats/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L120">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Plugin_DalamudPluginInterface_Log_" data-uid="Dalamud.Plugin.DalamudPluginInterface.Log*"></a>
|
||||
<h4 id="Dalamud_Plugin_DalamudPluginInterface_Log_System_String_System_Object___" data-uid="Dalamud.Plugin.DalamudPluginInterface.Log(System.String,System.Object[])">Log(String, Object[])</h4>
|
||||
<div class="markdown level1 summary"><p>Log a templated message to the in-game debug log.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void Log(string messageTemplate, params object[] values)</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">messageTemplate</span></td>
|
||||
<td><p>The message template.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Object</span>[]</td>
|
||||
<td><span class="parametername">values</span></td>
|
||||
<td><p>Values to log.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_LogError_System_Exception_System_String_System_Object___.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.LogError(System.Exception%2CSystem.String%2CSystem.Object%5B%5D)%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/goaaats/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L140">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Plugin_DalamudPluginInterface_LogError_" data-uid="Dalamud.Plugin.DalamudPluginInterface.LogError*"></a>
|
||||
<h4 id="Dalamud_Plugin_DalamudPluginInterface_LogError_System_Exception_System_String_System_Object___" data-uid="Dalamud.Plugin.DalamudPluginInterface.LogError(System.Exception,System.String,System.Object[])">LogError(Exception, String, Object[])</h4>
|
||||
<div class="markdown level1 summary"><p>Log a templated error message to the in-game debug log.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void LogError(Exception exception, string messageTemplate, params object[] values)</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.Exception</span></td>
|
||||
<td><span class="parametername">exception</span></td>
|
||||
<td><p>The exception that caused the error.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.String</span></td>
|
||||
<td><span class="parametername">messageTemplate</span></td>
|
||||
<td><p>The message template.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Object</span>[]</td>
|
||||
<td><span class="parametername">values</span></td>
|
||||
<td><p>Values to log.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<span class="small pull-right mobile-hide">
|
||||
<span class="divider">|</span>
|
||||
<a href="https://github.com/goaaats/Dalamud/new/master/apiSpec/new?filename=Dalamud_Plugin_DalamudPluginInterface_LogError_System_String_System_Object___.md&value=---%0Auid%3A%20Dalamud.Plugin.DalamudPluginInterface.LogError(System.String%2CSystem.Object%5B%5D)%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/goaaats/Dalamud/blob/master/Dalamud/Plugin/DalamudPluginInterface.cs/#L129">View Source</a>
|
||||
</span>
|
||||
<a id="Dalamud_Plugin_DalamudPluginInterface_LogError_" data-uid="Dalamud.Plugin.DalamudPluginInterface.LogError*"></a>
|
||||
<h4 id="Dalamud_Plugin_DalamudPluginInterface_LogError_System_String_System_Object___" data-uid="Dalamud.Plugin.DalamudPluginInterface.LogError(System.String,System.Object[])">LogError(String, Object[])</h4>
|
||||
<div class="markdown level1 summary"><p>Log a templated error message to the in-game debug log.</p>
|
||||
</div>
|
||||
<div class="markdown level1 conceptual"></div>
|
||||
<h5 class="decalaration">Declaration</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public void LogError(string messageTemplate, params object[] values)</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">messageTemplate</span></td>
|
||||
<td><p>The message template.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><span class="xref">System.Object</span>[]</td>
|
||||
<td><span class="parametername">values</span></td>
|
||||
<td><p>Values to log.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
|
|
|||
|
|
@ -101,6 +101,7 @@
|
|||
<h5 id="ImGuiNET_RangeAccessor_1_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public struct RangeAccessor<T>
|
||||
|
||||
where T : struct</code></pre>
|
||||
</div>
|
||||
<h5 class="typeParameters">Type Parameters</h5>
|
||||
|
|
|
|||
|
|
@ -101,6 +101,7 @@
|
|||
<h5 id="ImGuiNET_RangePtrAccessor_1_syntax">Syntax</h5>
|
||||
<div class="codewrapper">
|
||||
<pre><code class="lang-csharp hljs">public struct RangePtrAccessor<T>
|
||||
|
||||
where T : struct</code></pre>
|
||||
</div>
|
||||
<h5 class="typeParameters">Type Parameters</h5>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue