Deploy code docs to GitHub Pages for workflow run 1390

Commit: 3b97530dd3
This commit is contained in:
tgstation-server
2023-11-05 21:34:31 +00:00
parent 412af18e20
commit 3a1e9b397a
4781 changed files with 73551 additions and 45493 deletions
+30 -25
View File
@@ -21,7 +21,7 @@
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">tgstation-server<span id="projectnumber">&#160;5.16.4</span>
<div id="projectname">tgstation-server<span id="projectnumber">&#160;5.17.0</span>
</div>
<div id="projectbrief">The /tg/station 13 server suite</div>
</td>
@@ -82,37 +82,42 @@ $(function() {
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="keyword">using </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_components.html">Tgstation.Server.Host.Components</a>;</div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="keyword">using </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_database.html">Tgstation.Server.Host.Database</a>;</div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="keyword">using </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_security.html">Tgstation.Server.Host.Security</a>;</div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_controllers.html">Tgstation.Server.Host.Controllers</a></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span>{</div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller.html"> 12</a></span> <span class="keyword">public</span> <span class="keyword">abstract</span> <span class="keyword">class </span><a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller.html">InstanceRequiredController</a> : <a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_component_interfacing_controller.html">ComponentInterfacingController</a></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> {</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller.html#afced24c71684101fc4bcfef68cbd0876"> 21</a></span> <span class="keyword">protected</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller.html#afced24c71684101fc4bcfef68cbd0876">InstanceRequiredController</a>(</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_database_1_1_i_database_context.html">IDatabaseContext</a> databaseContext,</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_authentication_context_factory.html">IAuthenticationContextFactory</a> authenticationContextFactory,</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> ILogger&lt;InstanceRequiredController&gt; logger,</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_components_1_1_i_instance_manager.html">IInstanceManager</a> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_component_interfacing_controller.html#a9a2c4d46ba2467c16b22172a98f1ba35">instanceManager</a>)</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> : base(</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> databaseContext,</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> authenticationContextFactory,</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> logger,</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_component_interfacing_controller.html#a9a2c4d46ba2467c16b22172a98f1ba35">instanceManager</a>,</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> true)</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> {</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> }</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> }</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span>}</div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="keyword">using </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_utils.html">Tgstation.Server.Host.Utils</a>;</div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span> </div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespace_tgstation_1_1_server_1_1_host_1_1_controllers.html">Tgstation.Server.Host.Controllers</a></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span>{</div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller.html"> 13</a></span> <span class="keyword">public</span> <span class="keyword">abstract</span> <span class="keyword">class </span><a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller.html">InstanceRequiredController</a> : <a class="code hl_class" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_component_interfacing_controller.html">ComponentInterfacingController</a></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> {</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"><a class="line" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller.html#a9d38b9ca4b87794be730d77d3898b51b"> 23</a></span> <span class="keyword">protected</span> <a class="code hl_function" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller.html#a9d38b9ca4b87794be730d77d3898b51b">InstanceRequiredController</a>(</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_database_1_1_i_database_context.html">IDatabaseContext</a> databaseContext,</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span> <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_authentication_context.html">IAuthenticationContext</a> authenticationContext,</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> ILogger&lt;InstanceRequiredController&gt; logger,</div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span> <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_components_1_1_i_instance_manager.html">IInstanceManager</a> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_component_interfacing_controller.html#a9a2c4d46ba2467c16b22172a98f1ba35">instanceManager</a>,</div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> <a class="code hl_interface" href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_i_api_headers_provider.html">IApiHeadersProvider</a> apiHeaders)</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> : base(</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> databaseContext,</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> authenticationContext,</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> logger,</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> <a class="code hl_variable" href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_component_interfacing_controller.html#a9a2c4d46ba2467c16b22172a98f1ba35">instanceManager</a>,</div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno"> 34</span> apiHeaders,</div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"> 35</span> true)</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> {</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> }</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> }</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span>}</div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_component_interfacing_controller_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_component_interfacing_controller.html">Tgstation.Server.Host.Controllers.ComponentInterfacingController</a></div><div class="ttdoc">ApiController for operations on IInstanceCores.</div><div class="ttdef"><b>Definition:</b> <a href="_component_interfacing_controller_8cs_source.html#l00021">ComponentInterfacingController.cs:22</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_component_interfacing_controller_html_a9a2c4d46ba2467c16b22172a98f1ba35"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_component_interfacing_controller.html#a9a2c4d46ba2467c16b22172a98f1ba35">Tgstation.Server.Host.Controllers.ComponentInterfacingController.instanceManager</a></div><div class="ttdeci">readonly IInstanceManager instanceManager</div><div class="ttdoc">The IInstanceManager for the ComponentInterfacingController.</div><div class="ttdef"><b>Definition:</b> <a href="_component_interfacing_controller_8cs_source.html#l00031">ComponentInterfacingController.cs:31</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller.html">Tgstation.Server.Host.Controllers.InstanceRequiredController</a></div><div class="ttdoc">ComponentInterfacingController for operations that require an instance.</div><div class="ttdef"><b>Definition:</b> <a href="_instance_required_controller_8cs_source.html#l00012">InstanceRequiredController.cs:13</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller_html_afced24c71684101fc4bcfef68cbd0876"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller.html#afced24c71684101fc4bcfef68cbd0876">Tgstation.Server.Host.Controllers.InstanceRequiredController.InstanceRequiredController</a></div><div class="ttdeci">InstanceRequiredController(IDatabaseContext databaseContext, IAuthenticationContextFactory authenticationContextFactory, ILogger&lt; InstanceRequiredController &gt; logger, IInstanceManager instanceManager)</div><div class="ttdoc">Initializes a new instance of the InstanceRequiredController class.</div><div class="ttdef"><b>Definition:</b> <a href="_instance_required_controller_8cs_source.html#l00021">InstanceRequiredController.cs:21</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller_html"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller.html">Tgstation.Server.Host.Controllers.InstanceRequiredController</a></div><div class="ttdoc">ComponentInterfacingController for operations that require an instance.</div><div class="ttdef"><b>Definition:</b> <a href="_instance_required_controller_8cs_source.html#l00013">InstanceRequiredController.cs:14</a></div></div>
<div class="ttc" id="aclass_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller_html_a9d38b9ca4b87794be730d77d3898b51b"><div class="ttname"><a href="class_tgstation_1_1_server_1_1_host_1_1_controllers_1_1_instance_required_controller.html#a9d38b9ca4b87794be730d77d3898b51b">Tgstation.Server.Host.Controllers.InstanceRequiredController.InstanceRequiredController</a></div><div class="ttdeci">InstanceRequiredController(IDatabaseContext databaseContext, IAuthenticationContext authenticationContext, ILogger&lt; InstanceRequiredController &gt; logger, IInstanceManager instanceManager, IApiHeadersProvider apiHeaders)</div><div class="ttdoc">Initializes a new instance of the InstanceRequiredController class.</div><div class="ttdef"><b>Definition:</b> <a href="_instance_required_controller_8cs_source.html#l00023">InstanceRequiredController.cs:23</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_components_1_1_i_instance_manager_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_components_1_1_i_instance_manager.html">Tgstation.Server.Host.Components.IInstanceManager</a></div><div class="ttdoc">For managing IInstances.</div><div class="ttdef"><b>Definition:</b> <a href="_i_instance_manager_8cs_source.html#l00010">IInstanceManager.cs:11</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_database_1_1_i_database_context_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_database_1_1_i_database_context.html">Tgstation.Server.Host.Database.IDatabaseContext</a></div><div class="ttdoc">Represents the database.</div><div class="ttdef"><b>Definition:</b> <a href="_i_database_context_8cs_source.html#l00016">IDatabaseContext.cs:17</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_authentication_context_factory_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_authentication_context_factory.html">Tgstation.Server.Host.Security.IAuthenticationContextFactory</a></div><div class="ttdoc">For creating and accessing authentication contexts.</div><div class="ttdef"><b>Definition:</b> <a href="_i_authentication_context_factory_8cs_source.html#l00010">IAuthenticationContextFactory.cs:11</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_authentication_context_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_security_1_1_i_authentication_context.html">Tgstation.Server.Host.Security.IAuthenticationContext</a></div><div class="ttdoc">Represents the currently authenticated Models.User.</div><div class="ttdef"><b>Definition:</b> <a href="_i_authentication_context_8cs_source.html#l00009">IAuthenticationContext.cs:10</a></div></div>
<div class="ttc" id="ainterface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_i_api_headers_provider_html"><div class="ttname"><a href="interface_tgstation_1_1_server_1_1_host_1_1_utils_1_1_i_api_headers_provider.html">Tgstation.Server.Host.Utils.IApiHeadersProvider</a></div><div class="ttdoc">Provides ApiHeaders.</div><div class="ttdef"><b>Definition:</b> <a href="_i_api_headers_provider_8cs_source.html#l00008">IApiHeadersProvider.cs:9</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_components_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_components.html">Tgstation.Server.Host.Components</a></div><div class="ttdef"><b>Definition:</b> <a href="_byond_executable_lock_8cs_source.html#l00005">ByondExecutableLock.cs:6</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_controllers_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_controllers.html">Tgstation.Server.Host.Controllers</a></div><div class="ttdef"><b>Definition:</b> <a href="_administration_controller_8cs_source.html#l00030">AdministrationController.cs:31</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_controllers_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_controllers.html">Tgstation.Server.Host.Controllers</a></div><div class="ttdef"><b>Definition:</b> <a href="_administration_controller_8cs_source.html#l00032">AdministrationController.cs:33</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_database_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_database.html">Tgstation.Server.Host.Database</a></div><div class="ttdef"><b>Definition:</b> <a href="_database_collection_8cs_source.html#l00010">DatabaseCollection.cs:11</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_security_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_security.html">Tgstation.Server.Host.Security</a></div><div class="ttdef"><b>Definition:</b> <a href="_authentication_context_8cs_source.html#l00007">AuthenticationContext.cs:8</a></div></div>
<div class="ttc" id="anamespace_tgstation_1_1_server_1_1_host_1_1_utils_html"><div class="ttname"><a href="namespace_tgstation_1_1_server_1_1_host_1_1_utils.html">Tgstation.Server.Host.Utils</a></div><div class="ttdef"><b>Definition:</b> <a href="_abstract_http_client_factory_8cs_source.html#l00009">AbstractHttpClientFactory.cs:10</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>