From 9df15fcae4b67e9c9b7aaf7dad59150ed805480d Mon Sep 17 00:00:00 2001 From: goat Date: Sat, 15 Feb 2020 21:30:16 +0900 Subject: [PATCH] docs: regenerate for log funcs --- docs/README.html | 3 + ...Dalamud.Plugin.DalamudPluginInterface.html | 126 ++++++++++++++++++ docs/api/ImGuiNET.RangeAccessor-1.html | 1 + docs/api/ImGuiNET.RangePtrAccessor-1.html | 1 + docs/manifest.json | 82 ++++++------ docs/xrefmap.yml | 41 ++++++ 6 files changed, 213 insertions(+), 41 deletions(-) diff --git a/docs/README.html b/docs/README.html index 7bd4b16bf..81c1f0603 100644 --- a/docs/README.html +++ b/docs/README.html @@ -63,6 +63,9 @@

Dalamud Actions Status

FFXIV Hooking framework for FFXIVQuickLauncher.

+

Plugin development

+

Dalamud features a growing API for in-game plugin development with game data and chat access and overlays. +Please see the API documentation for more details.

Thanks to Mino, whose work has made this possible!

diff --git a/docs/api/Dalamud.Plugin.DalamudPluginInterface.html b/docs/api/Dalamud.Plugin.DalamudPluginInterface.html index 34969fac9..50b4c896c 100644 --- a/docs/api/Dalamud.Plugin.DalamudPluginInterface.html +++ b/docs/api/Dalamud.Plugin.DalamudPluginInterface.html @@ -383,6 +383,132 @@ IPluginConfiguration

A previously saved config or null if none was saved before.

+ + + + + + | + Improve this Doc + + + View Source + + +

Log(String, Object[])

+

Log a templated message to the in-game debug log.

+
+
+
Declaration
+
+ 
public void Log(string messageTemplate, params object[] values)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
System.StringmessageTemplate

The message template.

+
System.Object[]values

Values to log.

+
+ + | + Improve this Doc + + + View Source + + +

LogError(Exception, String, Object[])

+

Log a templated error message to the in-game debug log.

+
+
+
Declaration
+
+ 
public void LogError(Exception exception, string messageTemplate, params object[] values)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
System.Exceptionexception

The exception that caused the error.

+
System.StringmessageTemplate

The message template.

+
System.Object[]values

Values to log.

+
+ + | + Improve this Doc + + + View Source + + +

LogError(String, Object[])

+

Log a templated error message to the in-game debug log.

+
+
+
Declaration
+
+ 
public void LogError(string messageTemplate, params object[] values)
+
+
Parameters
+ + + + + + + + + + + + + + + + + + diff --git a/docs/api/ImGuiNET.RangeAccessor-1.html b/docs/api/ImGuiNET.RangeAccessor-1.html index 3bad91f9c..f38c70165 100644 --- a/docs/api/ImGuiNET.RangeAccessor-1.html +++ b/docs/api/ImGuiNET.RangeAccessor-1.html @@ -101,6 +101,7 @@
Syntax
public struct RangeAccessor<T>
+
     where T : struct
Type Parameters
diff --git a/docs/api/ImGuiNET.RangePtrAccessor-1.html b/docs/api/ImGuiNET.RangePtrAccessor-1.html index bfcac7e52..99645455e 100644 --- a/docs/api/ImGuiNET.RangePtrAccessor-1.html +++ b/docs/api/ImGuiNET.RangePtrAccessor-1.html @@ -101,6 +101,7 @@
Syntax
public struct RangePtrAccessor<T>
+
     where T : struct
Type Parameters
diff --git a/docs/manifest.json b/docs/manifest.json index 9d72bc102..916b257e2 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -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 } } }, diff --git a/docs/xrefmap.yml b/docs/xrefmap.yml index 046dbeb77..4331257bd 100644 --- a/docs/xrefmap.yml +++ b/docs/xrefmap.yml @@ -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_
TypeNameDescription
System.StringmessageTemplate

The message template.

+
System.Object[]values

Values to log.