docs: regenerate

2025-12-12 18:27:23 +01:00 · 2021-04-25 15:20:12 +02:00 · 2021-04-25 15:20:12 +02:00 · 392376b3fc
commit 392376b3fc
parent 62e44bf30f
106 changed files with 4881 additions and 2447 deletions
--- a/docs/api/Dalamud.Localization.html
+++ b/docs/api/Dalamud.Localization.html
@ -115,19 +115,19 @@
  </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_Localization__ctor_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Localization.%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>
+    <a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Localization__ctor_System_String_System_String_System_Boolean_.md&amp;value=---%0Auid%3A%20Dalamud.Localization.%23ctor(System.String%2CSystem.String%2CSystem.Boolean)%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/Localization.cs/#L29">View Source</a>
+    <a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Localization.cs/#L35">View Source</a>
  </span>
  <a id="Dalamud_Localization__ctor_" data-uid="Dalamud.Localization.#ctor*"></a>
-  <h4 id="Dalamud_Localization__ctor_System_String_" data-uid="Dalamud.Localization.#ctor(System.String)">Localization(String)</h4>
+  <h4 id="Dalamud_Localization__ctor_System_String_System_String_System_Boolean_" data-uid="Dalamud.Localization.#ctor(System.String,System.String,System.Boolean)">Localization(String, String, Boolean)</h4>
  <div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Dalamud.Localization.html">Localization</a> class.</p>
 </div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public Localization(string workingDirectory)</code></pre>
+    <pre><code class="lang-csharp hljs">public Localization(string locResourceDirectory, string locResourcePrefix = &quot;&quot;, bool useEmbedded = false)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
@ -141,8 +141,20 @@
    <tbody>
      <tr>
        <td><span class="xref">System.String</span></td>
-        <td><span class="parametername">workingDirectory</span></td>
+        <td><span class="parametername">locResourceDirectory</span></td>
        <td><p>The working directory to load language files from.</p>
+</td>
+      </tr>
+      <tr>
+        <td><span class="xref">System.String</span></td>
+        <td><span class="parametername">locResourcePrefix</span></td>
+        <td><p>The prefix on the loc resource file name (e.g. dalamud_).</p>
+</td>
+      </tr>
+      <tr>
+        <td><span class="xref">System.Boolean</span></td>
+        <td><span class="parametername">useEmbedded</span></td>
+        <td><p>Use embedded loc resource files.</p>
 </td>
      </tr>
    </tbody>
@ -154,7 +166,7 @@
    <a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Localization_ApplicableLangCodes.md&amp;value=---%0Auid%3A%20Dalamud.Localization.ApplicableLangCodes%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/Localization.cs/#L19">View Source</a>
+    <a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Localization.cs/#L20">View Source</a>
  </span>
  <h4 id="Dalamud_Localization_ApplicableLangCodes" data-uid="Dalamud.Localization.ApplicableLangCodes">ApplicableLangCodes</h4>
  <div class="markdown level1 summary"><p>Array of language codes which have a valid translation in Dalamud.</p>
@ -181,12 +193,86 @@
  </table>
  <h3 id="methods">Methods
  </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_Localization_ExportLocalizable.md&amp;value=---%0Auid%3A%20Dalamud.Localization.ExportLocalizable%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/Localization.cs/#L116">View Source</a>
+  </span>
+  <a id="Dalamud_Localization_ExportLocalizable_" data-uid="Dalamud.Localization.ExportLocalizable*"></a>
+  <h4 id="Dalamud_Localization_ExportLocalizable" data-uid="Dalamud.Localization.ExportLocalizable">ExportLocalizable()</h4>
+  <div class="markdown level1 summary"><p>Saves localizable JSON data in the current working directory for the provided assembly.</p>
+</div>
+  <div class="markdown level1 conceptual"></div>
+  <h5 class="decalaration">Declaration</h5>
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">public void ExportLocalizable()</code></pre>
+  </div>
+  <span class="small pull-right mobile-hide">
+    <span class="divider">|</span>
+    <a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Localization_Localize_System_String_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Localization.Localize(System.String%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/Localization.cs/#L129">View Source</a>
+  </span>
+  <a id="Dalamud_Localization_Localize_" data-uid="Dalamud.Localization.Localize*"></a>
+  <h4 id="Dalamud_Localization_Localize_System_String_System_String_" data-uid="Dalamud.Localization.Localize(System.String,System.String)">Localize(String, String)</h4>
+  <div class="markdown level1 summary"><p>Search the set-up localization data for the provided assembly for the given string key and return it.
+If the key is not present, the fallback is shown.
+The fallback is also required to create the string files to be localized.</p>
+</div>
+  <div class="markdown level1 conceptual"></div>
+  <h5 class="decalaration">Declaration</h5>
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">public string Localize(string key, string fallBack)</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">key</span></td>
+        <td><p>The string key to be returned.</p>
+</td>
+      </tr>
+      <tr>
+        <td><span class="xref">System.String</span></td>
+        <td><span class="parametername">fallBack</span></td>
+        <td><p>The fallback string, usually your source language.</p>
+</td>
+      </tr>
+    </tbody>
+  </table>
+  <h5 class="returns">Returns</h5>
+  <table class="table table-bordered table-striped table-condensed">
+    <thead>
+      <tr>
+        <th>Type</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td><span class="xref">System.String</span></td>
+        <td><p>The localized string, fallback or string key if not found.</p>
+</td>
+      </tr>
+    </tbody>
+  </table>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Localization_SetupWithFallbacks.md&amp;value=---%0Auid%3A%20Dalamud.Localization.SetupWithFallbacks%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/Localization.cs/#L74">View Source</a>
+    <a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Localization.cs/#L83">View Source</a>
  </span>
  <a id="Dalamud_Localization_SetupWithFallbacks_" data-uid="Dalamud.Localization.SetupWithFallbacks*"></a>
  <h4 id="Dalamud_Localization_SetupWithFallbacks" data-uid="Dalamud.Localization.SetupWithFallbacks">SetupWithFallbacks()</h4>
@ -202,7 +288,7 @@
    <a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Localization_SetupWithLangCode_System_String_.md&amp;value=---%0Auid%3A%20Dalamud.Localization.SetupWithLangCode(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/Localization.cs/#L84">View Source</a>
+    <a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Localization.cs/#L93">View Source</a>
  </span>
  <a id="Dalamud_Localization_SetupWithLangCode_" data-uid="Dalamud.Localization.SetupWithLangCode*"></a>
  <h4 id="Dalamud_Localization_SetupWithLangCode_System_String_" data-uid="Dalamud.Localization.SetupWithLangCode(System.String)">SetupWithLangCode(String)</h4>
@ -236,7 +322,7 @@
    <a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Localization_SetupWithUiCulture.md&amp;value=---%0Auid%3A%20Dalamud.Localization.SetupWithUiCulture%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/Localization.cs/#L48">View Source</a>
+    <a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Localization.cs/#L57">View Source</a>
  </span>
  <a id="Dalamud_Localization_SetupWithUiCulture_" data-uid="Dalamud.Localization.SetupWithUiCulture*"></a>
  <h4 id="Dalamud_Localization_SetupWithUiCulture" data-uid="Dalamud.Localization.SetupWithUiCulture">SetupWithUiCulture()</h4>
@ -254,7 +340,7 @@
    <a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Localization_OnLocalizationChanged.md&amp;value=---%0Auid%3A%20Dalamud.Localization.OnLocalizationChanged%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/Localization.cs/#L43">View Source</a>
+    <a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Localization.cs/#L52">View Source</a>
  </span>
  <h4 id="Dalamud_Localization_OnLocalizationChanged" data-uid="Dalamud.Localization.OnLocalizationChanged">OnLocalizationChanged</h4>
  <div class="markdown level1 summary"><p>Event that occurs when the language is changed.</p>
@ -290,7 +376,7 @@
                    <a href="https://github.com/goatcorp/Dalamud/new/master/apiSpec/new?filename=Dalamud_Localization.md&amp;value=---%0Auid%3A%20Dalamud.Localization%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/Localization.cs/#L14" class="contribution-link">View Source</a>
+                    <a href="https://github.com/goatcorp/Dalamud/blob/master/Dalamud/Localization.cs/#L15" class="contribution-link">View Source</a>
                  </li>
                </ul>
              </div>