Deploy code docs to GitHub Pages for workflow run 3435

Commit: 5889c6e454
This commit is contained in:
tgstation-server-ci[bot]
2024-10-29 13:12:01 +00:00
parent 5693cc8b06
commit 399204d259
4188 changed files with 5164 additions and 5051 deletions
+6 -6
View File
@@ -21,7 +21,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">tgstation-server<span id="projectnumber">&#160;6.11.2</span>
<div id="projectname">tgstation-server<span id="projectnumber">&#160;6.11.3</span>
</div>
<div id="projectbrief">The /tg/station 13 server suite</div>
</td>
@@ -175,7 +175,7 @@ $(document).ready(function() { init_codefold(0); });
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> {</div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_engine_manager.html#a06d4c2604e3020f77b073021bf3016b4">CheckVersionParameter</a>(version);</div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> </div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> <span class="keyword">using</span> (await <a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_semaphore_slim_context.html">SemaphoreSlimContext</a>.<a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_semaphore_slim_context.html#a29773d588476671bbe480f096d839c91">Lock</a>(<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_engine_manager.html#a9fa07230c89ba8367a0b141ee2ab63cd">changeDeleteSemaphore</a>, cancellationToken))</div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span> <span class="keyword">using</span> (await <a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_semaphore_slim_context.html">SemaphoreSlimContext</a>.<a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_semaphore_slim_context.html#abeb1f086e2752f6f9a4d3d175a4392af">Lock</a>(<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_engine_manager.html#a9fa07230c89ba8367a0b141ee2ab63cd">changeDeleteSemaphore</a>, cancellationToken))</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"> 130</span> {</div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span> <span class="keyword">using </span>var installLock = await <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_engine_manager.html#a4d0593064aa1c11835cfa1ab2823ec34">AssertAndLockVersion</a>(</div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span> progressReporter,</div>
@@ -275,7 +275,7 @@ $(document).ready(function() { init_codefold(0); });
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno"> 224</span> </div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno"> 225</span> <span class="comment">// We also want to check when the active version changes in case we need to fail the job because of that.</span></div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno"> 226</span> Task activeVersionUpdate;</div>
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno"> 227</span> <span class="keyword">using</span> (await <a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_semaphore_slim_context.html">SemaphoreSlimContext</a>.<a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_semaphore_slim_context.html#a29773d588476671bbe480f096d839c91">Lock</a>(<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_engine_manager.html#a9fa07230c89ba8367a0b141ee2ab63cd">changeDeleteSemaphore</a>, cancellationToken))</div>
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno"> 227</span> <span class="keyword">using</span> (await <a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_semaphore_slim_context.html">SemaphoreSlimContext</a>.<a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_semaphore_slim_context.html#abeb1f086e2752f6f9a4d3d175a4392af">Lock</a>(<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_engine_manager.html#a9fa07230c89ba8367a0b141ee2ab63cd">changeDeleteSemaphore</a>, cancellationToken))</div>
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno"> 228</span> activeVersionUpdate = <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_engine_manager.html#a521ab9e66773b880ab21cf95eb69b9ec">activeVersionChanged</a>.Task;</div>
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno"> 229</span> </div>
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno"> 230</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_engine_manager.html#ac39c6d367c69e5a63d14bbaace141831">logger</a>.LogTrace(<span class="stringliteral">&quot;Waiting for container.OnZeroReferences or switch of active version...&quot;</span>);</div>
@@ -289,7 +289,7 @@ $(document).ready(function() { init_codefold(0); });
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno"> 238</span> <span class="keywordflow">else</span></div>
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno"> 239</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_engine_manager.html#ac39c6d367c69e5a63d14bbaace141831">logger</a>.LogTrace(<span class="stringliteral">&quot;activeVersion changed, we may have to wait again. Acquiring semaphore...&quot;</span>);</div>
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno"> 240</span> </div>
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno"> 241</span> <span class="keyword">using</span> (await <a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_semaphore_slim_context.html">SemaphoreSlimContext</a>.<a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_semaphore_slim_context.html#a29773d588476671bbe480f096d839c91">Lock</a>(<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_engine_manager.html#a9fa07230c89ba8367a0b141ee2ab63cd">changeDeleteSemaphore</a>, cancellationToken))</div>
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno"> 241</span> <span class="keyword">using</span> (await <a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_semaphore_slim_context.html">SemaphoreSlimContext</a>.<a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_semaphore_slim_context.html#abeb1f086e2752f6f9a4d3d175a4392af">Lock</a>(<a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_engine_manager.html#a9fa07230c89ba8367a0b141ee2ab63cd">changeDeleteSemaphore</a>, cancellationToken))</div>
<div class="line"><a id="l00242" name="l00242"></a><span class="lineno"> 242</span> {</div>
<div class="line"><a id="l00243" name="l00243"></a><span class="lineno"> 243</span> <span class="comment">// check again because it could have become the active version.</span></div>
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno"> 244</span> activeVersion = <a class="code hl_property" href="class_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_engine_manager.html#a8fed5e758f8c7a456fd726cc505396f6">ActiveVersion</a>;</div>
@@ -698,8 +698,8 @@ $(document).ready(function() { init_codefold(0); });
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_utils_1_1_reference_counting_container_html_a1a512890f504f0e2fa9593bbd5ab851f"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_reference_counting_container.html#a1a512890f504f0e2fa9593bbd5ab851f">Tgstation.Server.Host.Utils.ReferenceCountingContainer.AddReference</a></div><div class="ttdeci">TReference AddReference()</div><div class="ttdoc">Create a new TReference to the Instance.</div><div class="ttdef"><b>Definition</b> <a href="_reference_counting_container_8cs_source.html#l00066">ReferenceCountingContainer.cs:66</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_utils_1_1_reference_counting_container_html_a54d1a80d386b5d827108e8d7d93064c3"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_reference_counting_container.html#a54d1a80d386b5d827108e8d7d93064c3">Tgstation.Server.Host.Utils.ReferenceCountingContainer.Instance</a></div><div class="ttdeci">TWrapped Instance</div><div class="ttdoc">The TWrapped .</div><div class="ttdef"><b>Definition</b> <a href="_reference_counting_container_8cs_source.html#l00018">ReferenceCountingContainer.cs:18</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_utils_1_1_reference_counting_container_html_aa313916be969b264bc13c54b69976b17"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_reference_counting_container.html#aa313916be969b264bc13c54b69976b17">Tgstation.Server.Host.Utils.ReferenceCountingContainer.OnZeroReferences</a></div><div class="ttdeci">Task OnZeroReferences</div><div class="ttdoc">A Task that completes when there are no TReference s active for the Instance.</div><div class="ttdef"><b>Definition</b> <a href="_reference_counting_container_8cs_source.html#l00023">ReferenceCountingContainer.cs:24</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_utils_1_1_semaphore_slim_context_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_semaphore_slim_context.html">Tgstation.Server.Host.Utils.SemaphoreSlimContext</a></div><div class="ttdoc">Async lock context helper.</div><div class="ttdef"><b>Definition</b> <a href="_semaphore_slim_context_8cs_source.html#l00010">SemaphoreSlimContext.cs:11</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_utils_1_1_semaphore_slim_context_html_a29773d588476671bbe480f096d839c91"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_semaphore_slim_context.html#a29773d588476671bbe480f096d839c91">Tgstation.Server.Host.Utils.SemaphoreSlimContext.Lock</a></div><div class="ttdeci">static async ValueTask&lt; SemaphoreSlimContext &gt; Lock(SemaphoreSlim semaphore, CancellationToken cancellationToken)</div><div class="ttdoc">Asyncronously locks a semaphore .</div><div class="ttdef"><b>Definition</b> <a href="_semaphore_slim_context_8cs_source.html#l00018">SemaphoreSlimContext.cs:18</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_utils_1_1_semaphore_slim_context_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_semaphore_slim_context.html">Tgstation.Server.Host.Utils.SemaphoreSlimContext</a></div><div class="ttdoc">Async lock context helper.</div><div class="ttdef"><b>Definition</b> <a href="_semaphore_slim_context_8cs_source.html#l00012">SemaphoreSlimContext.cs:13</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_utils_1_1_semaphore_slim_context_html_abeb1f086e2752f6f9a4d3d175a4392af"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_utils_1_1_semaphore_slim_context.html#abeb1f086e2752f6f9a4d3d175a4392af">Tgstation.Server.Host.Utils.SemaphoreSlimContext.Lock</a></div><div class="ttdeci">static async ValueTask&lt; SemaphoreSlimContext &gt; Lock(SemaphoreSlim semaphore, CancellationToken cancellationToken, ILogger? logger=null)</div><div class="ttdoc">Asyncronously locks a semaphore .</div><div class="ttdef"><b>Definition</b> <a href="_semaphore_slim_context_8cs_source.html#l00021">SemaphoreSlimContext.cs:21</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_i_engine_installation_data_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_i_engine_installation_data.html">Tgstation.Server.Host.Components.Engine.IEngineInstallationData</a></div><div class="ttdoc">Wraps data containing an engine installation.</div><div class="ttdef"><b>Definition</b> <a href="_i_engine_installation_data_8cs_source.html#l00010">IEngineInstallationData.cs:11</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_i_engine_installation_data_html_ae712d13d543fde6cbb64c9085f9370b7"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_i_engine_installation_data.html#ae712d13d543fde6cbb64c9085f9370b7">Tgstation.Server.Host.Components.Engine.IEngineInstallationData.ExtractToPath</a></div><div class="ttdeci">Task ExtractToPath(string path, CancellationToken cancellationToken)</div><div class="ttdoc">Extracts the installation to a given path.</div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_i_engine_installation_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_components_1_1_engine_1_1_i_engine_installation.html">Tgstation.Server.Host.Components.Engine.IEngineInstallation</a></div><div class="ttdoc">Represents a BYOND installation.</div><div class="ttdef"><b>Definition</b> <a href="_i_engine_installation_8cs_source.html#l00017">IEngineInstallation.cs:18</a></div></div>