docs: regenerate for log funcs

This commit is contained in:
goat 2020-02-15 21:30:16 +09:00
parent 3a688b9219
commit 9df15fcae4
6 changed files with 213 additions and 41 deletions

View file

@ -63,6 +63,9 @@
<h1 id="dalamud--actions-status">Dalamud <a href="https://github.com/goaaats/Dalamud/actions"><img src="https://github.com/goaaats/Dalamud/workflows/Build%20Dalamud/badge.svg" alt="Actions Status"></a></h1>
<p>FFXIV Hooking framework for <a href="https://github.com/goaaats/FFXIVQuickLauncher">FFXIVQuickLauncher</a>.</p>
<h2 id="plugin-development">Plugin development</h2>
<p>Dalamud features a growing API for in-game plugin development with game data and chat access and overlays.
Please see the <a href="https://goaaats.github.io/Dalamud/api/index.html">API documentation</a> for more details.</p>
<p>Thanks to Mino, whose work has made this possible!</p>
</article>
</div>

View file

@ -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&amp;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&amp;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&amp;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>

View file

@ -101,6 +101,7 @@
<h5 id="ImGuiNET_RangeAccessor_1_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public struct RangeAccessor&lt;T&gt;
where T : struct</code></pre>
</div>
<h5 class="typeParameters">Type Parameters</h5>

View file

@ -101,6 +101,7 @@
<h5 id="ImGuiNET_RangePtrAccessor_1_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public struct RangePtrAccessor&lt;T&gt;
where T : struct</code></pre>
</div>
<h5 class="typeParameters">Type Parameters</h5>

View file

@ -9,10 +9,10 @@
"output": {
".html": {
"relative_path": "README.html",
"hash": "8orRU3u5G1Cthb1hC2FwrQ=="
"hash": "NhK9M7RY7E1AZM8j+RSJ3A=="
}
},
"is_incremental": true,
"is_incremental": false,
"version": ""
},
{
@ -1332,7 +1332,7 @@
"hash": "xAuET1ZQ7JnYTUeS1LYdpg=="
}
},
"is_incremental": true,
"is_incremental": false,
"version": ""
},
{
@ -1368,7 +1368,7 @@
"hash": "IzeQxJL9ZpMzY/4oXrlN2w=="
}
},
"is_incremental": true,
"is_incremental": false,
"version": ""
},
{
@ -1380,7 +1380,7 @@
"hash": "X9p3on2vILi8oK3E83yTww=="
}
},
"is_incremental": true,
"is_incremental": false,
"version": ""
},
{
@ -1389,10 +1389,10 @@
"output": {
".html": {
"relative_path": "api/Dalamud.Plugin.DalamudPluginInterface.html",
"hash": "lwWtlnesi2CqyMf7iuWb3g=="
"hash": "W3UXnM08nCDlSMLn+SbOxQ=="
}
},
"is_incremental": true,
"is_incremental": false,
"version": ""
},
{
@ -1404,7 +1404,7 @@
"hash": "eK8MN2VBnsmaJ6HD9zTE7g=="
}
},
"is_incremental": true,
"is_incremental": false,
"version": ""
},
{
@ -1416,7 +1416,7 @@
"hash": "A0zCX5VoCtkNN5KOIG5LUg=="
}
},
"is_incremental": true,
"is_incremental": false,
"version": ""
},
{
@ -2409,10 +2409,10 @@
"output": {
".html": {
"relative_path": "api/ImGuiNET.RangeAccessor-1.html",
"hash": "31V1mUauG5peFRm+w9OiuA=="
"hash": "Kh0MYHMlyDYvkQtSlSll3Q=="
}
},
"is_incremental": true,
"is_incremental": false,
"version": ""
},
{
@ -2433,10 +2433,10 @@
"output": {
".html": {
"relative_path": "api/ImGuiNET.RangePtrAccessor-1.html",
"hash": "8x4YQsZqkK/v4cZX0kKb+Q=="
"hash": "vTcVpOM+Bj+06V7IrpE0Kw=="
}
},
"is_incremental": true,
"is_incremental": false,
"version": ""
},
{
@ -2460,7 +2460,7 @@
"hash": "UUrAjBrcpudtscr5yjeI5Q=="
}
},
"is_incremental": true,
"is_incremental": false,
"version": ""
},
{
@ -2496,7 +2496,7 @@
"hash": "m70EnwYpdcTr4IFG/dY7pA=="
}
},
"is_incremental": true,
"is_incremental": false,
"version": ""
},
{
@ -2508,7 +2508,7 @@
"hash": "0myJmmh7p8nmmlRvpfMG/g=="
}
},
"is_incremental": true,
"is_incremental": false,
"version": ""
},
{
@ -2532,7 +2532,7 @@
"hash": "FiW8JCdFBiSKbSPUM15AjQ=="
}
},
"is_incremental": true,
"is_incremental": false,
"version": ""
},
{
@ -2544,7 +2544,7 @@
"hash": "21rrOfJhiQR1FpvCTrCQbg=="
}
},
"is_incremental": true,
"is_incremental": false,
"version": ""
},
{
@ -2556,7 +2556,7 @@
"hash": "S/C5yjjEv6wxyeALOTPkdg=="
}
},
"is_incremental": true,
"is_incremental": false,
"version": ""
},
{
@ -2568,7 +2568,7 @@
"hash": "hkn1tdXrcHgch+byxtufdQ=="
}
},
"is_incremental": true,
"is_incremental": false,
"version": ""
},
{
@ -2580,7 +2580,7 @@
"hash": "Al7grMkOdZEI9My4/pz28g=="
}
},
"is_incremental": true,
"is_incremental": false,
"version": ""
},
{
@ -2604,7 +2604,7 @@
"hash": "D/MGhCZVMW6pEcnWwA9oGg=="
}
},
"is_incremental": true,
"is_incremental": false,
"version": ""
},
{
@ -2628,7 +2628,7 @@
"hash": "6LdaX92bdSC98J3as/V4tA=="
}
},
"is_incremental": true,
"is_incremental": false,
"version": ""
},
{
@ -2640,7 +2640,7 @@
"hash": "ZBOi1m9jaGP7kqrjsuyItg=="
}
},
"is_incremental": true,
"is_incremental": false,
"version": ""
},
{
@ -2652,7 +2652,7 @@
"hash": "sVXWZwHmRSqXH/+qhVAU7w=="
}
},
"is_incremental": true,
"is_incremental": false,
"version": ""
},
{
@ -2676,7 +2676,7 @@
"hash": "dVjVr8DioTKwvcuaAAvRNQ=="
}
},
"is_incremental": true,
"is_incremental": false,
"version": ""
},
{
@ -2688,7 +2688,7 @@
"hash": "SxPZHSdBaz1xUpZbH2gXqg=="
}
},
"is_incremental": true,
"is_incremental": false,
"version": ""
},
{
@ -2712,7 +2712,7 @@
"hash": "mwcp2LgADh72rwI5PEE0fA=="
}
},
"is_incremental": true,
"is_incremental": false,
"version": ""
},
{
@ -2724,7 +2724,7 @@
"hash": "p/kS1K3H9Kbxh+SVLR78Vw=="
}
},
"is_incremental": true,
"is_incremental": false,
"version": ""
},
{
@ -2748,7 +2748,7 @@
"hash": "AqzS4oIpe4R7BuAfYaigrw=="
}
},
"is_incremental": true,
"is_incremental": false,
"version": ""
},
{
@ -2760,7 +2760,7 @@
"hash": "4w1gqwosFfVP6gco98SpIA=="
}
},
"is_incremental": true,
"is_incremental": false,
"version": ""
},
{
@ -4428,7 +4428,7 @@
"hash": "Y7W3npbJph/JcPu1DOK3aQ=="
}
},
"is_incremental": false,
"is_incremental": true,
"version": ""
},
{
@ -4452,7 +4452,7 @@
"hash": "s84u+FH+UKO4kliIcL2f7w=="
}
},
"is_incremental": false,
"is_incremental": true,
"version": ""
}
],
@ -4465,24 +4465,24 @@
"skipped_file_count": 0
},
"processors": {
"TocDocumentProcessor": {
"can_incremental": false,
"details": "Processor TocDocumentProcessor cannot support incremental build because the processor doesn't implement ISupportIncrementalDocumentProcessor interface.",
"incrementalPhase": "build",
"total_file_count": 0,
"skipped_file_count": 0
},
"ManagedReferenceDocumentProcessor": {
"can_incremental": true,
"incrementalPhase": "build",
"total_file_count": 367,
"skipped_file_count": 367
"skipped_file_count": 350
},
"ConceptualDocumentProcessor": {
"can_incremental": true,
"incrementalPhase": "build",
"total_file_count": 3,
"skipped_file_count": 2
},
"TocDocumentProcessor": {
"can_incremental": false,
"details": "Processor TocDocumentProcessor cannot support incremental build because the processor doesn't implement ISupportIncrementalDocumentProcessor interface.",
"incrementalPhase": "build",
"total_file_count": 0,
"skipped_file_count": 0
}
}
},

View file

@ -4909,6 +4909,47 @@ references:
isSpec: "True"
fullName: Dalamud.Plugin.DalamudPluginInterface.GetPluginConfig
nameWithType: DalamudPluginInterface.GetPluginConfig
- uid: Dalamud.Plugin.DalamudPluginInterface.Log(System.String,System.Object[])
name: Log(String, Object[])
href: api/Dalamud.Plugin.DalamudPluginInterface.html#Dalamud_Plugin_DalamudPluginInterface_Log_System_String_System_Object___
commentId: M:Dalamud.Plugin.DalamudPluginInterface.Log(System.String,System.Object[])
name.vb: Log(String, Object())
fullName: Dalamud.Plugin.DalamudPluginInterface.Log(System.String, System.Object[])
fullName.vb: Dalamud.Plugin.DalamudPluginInterface.Log(System.String, System.Object())
nameWithType: DalamudPluginInterface.Log(String, Object[])
nameWithType.vb: DalamudPluginInterface.Log(String, Object())
- uid: Dalamud.Plugin.DalamudPluginInterface.Log*
name: Log
href: api/Dalamud.Plugin.DalamudPluginInterface.html#Dalamud_Plugin_DalamudPluginInterface_Log_
commentId: Overload:Dalamud.Plugin.DalamudPluginInterface.Log
isSpec: "True"
fullName: Dalamud.Plugin.DalamudPluginInterface.Log
nameWithType: DalamudPluginInterface.Log
- uid: Dalamud.Plugin.DalamudPluginInterface.LogError(System.Exception,System.String,System.Object[])
name: LogError(Exception, String, Object[])
href: api/Dalamud.Plugin.DalamudPluginInterface.html#Dalamud_Plugin_DalamudPluginInterface_LogError_System_Exception_System_String_System_Object___
commentId: M:Dalamud.Plugin.DalamudPluginInterface.LogError(System.Exception,System.String,System.Object[])
name.vb: LogError(Exception, String, Object())
fullName: Dalamud.Plugin.DalamudPluginInterface.LogError(System.Exception, System.String, System.Object[])
fullName.vb: Dalamud.Plugin.DalamudPluginInterface.LogError(System.Exception, System.String, System.Object())
nameWithType: DalamudPluginInterface.LogError(Exception, String, Object[])
nameWithType.vb: DalamudPluginInterface.LogError(Exception, String, Object())
- uid: Dalamud.Plugin.DalamudPluginInterface.LogError(System.String,System.Object[])
name: LogError(String, Object[])
href: api/Dalamud.Plugin.DalamudPluginInterface.html#Dalamud_Plugin_DalamudPluginInterface_LogError_System_String_System_Object___
commentId: M:Dalamud.Plugin.DalamudPluginInterface.LogError(System.String,System.Object[])
name.vb: LogError(String, Object())
fullName: Dalamud.Plugin.DalamudPluginInterface.LogError(System.String, System.Object[])
fullName.vb: Dalamud.Plugin.DalamudPluginInterface.LogError(System.String, System.Object())
nameWithType: DalamudPluginInterface.LogError(String, Object[])
nameWithType.vb: DalamudPluginInterface.LogError(String, Object())
- uid: Dalamud.Plugin.DalamudPluginInterface.LogError*
name: LogError
href: api/Dalamud.Plugin.DalamudPluginInterface.html#Dalamud_Plugin_DalamudPluginInterface_LogError_
commentId: Overload:Dalamud.Plugin.DalamudPluginInterface.LogError
isSpec: "True"
fullName: Dalamud.Plugin.DalamudPluginInterface.LogError
nameWithType: DalamudPluginInterface.LogError
- uid: Dalamud.Plugin.DalamudPluginInterface.SavePluginConfig(Dalamud.Configuration.IPluginConfiguration)
name: SavePluginConfig(IPluginConfiguration)
href: api/Dalamud.Plugin.DalamudPluginInterface.html#Dalamud_Plugin_DalamudPluginInterface_SavePluginConfig_Dalamud_Configuration_IPluginConfiguration_