cyberpresidentvanellope/tgstation-server
1
0
Fork 0
mirror of https://github.com/tgstation/tgstation-server.git synced 2026-08-25 05:56:58 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fix documentation errors

Browse Source
This commit is contained in:
Cyberboss
2017-10-30 12:43:00 -04:00
parent baf40bee31
commit 7f4e09bcd2
4 changed files with 14 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
TGServerService/EventID.cs
+6 -3
View File
@@ -41,16 +41,19 @@ namespace TGServerService
/// </summary>
BYONDUpdateComplete = 800,
/// <summary>
/// Error: Failed to move the <see cref="ServerInstance"/> with <see cref="TGServiceInterface.Components.ITGAdministration.MoveServer(string)"/>
/// Error: Failed to move the <see cref="ServerInstance"/> with TGServiceInterface.Components.ITGAdministration.MoveServer(string)
/// </summary>
[Obsolete("Not in use anymore", true)]
ServerMoveFailed = 900,
/// <summary>
/// Warning: Failed to delete the old directory during a <see cref="TGServiceInterface.Components.ITGAdministration.MoveServer(string)"/> operation
/// Warning: Failed to delete the old directory during a TGServiceInterface.Components.ITGAdministration.MoveServer(string) operation
/// </summary>
[Obsolete("Not in use anymore", true)]
ServerMovePartial = 1000,
/// <summary>
/// Info: Successful completion of a <see cref="TGServiceInterface.Components.ITGAdministration.MoveServer(string)"/> operation
/// Info: Successful completion of a TGServiceInterface.Components.ITGAdministration.MoveServer(string) operation
/// </summary>
[Obsolete("Not in use anymore", true)]
ServerMoveComplete = 1100,
/// <summary>
/// Error: An internal error occurred during a <see cref="TGServiceInterface.Components.ITGCompiler.Compile(bool)"/> operation
TGServerService/ServerInstance/DreamDaemon.cs
+3 -3
View File
@@ -92,7 +92,7 @@ namespace TGServerService
ShutdownRequestPhase AwaitingShutdown;
/// <summary>
/// Setup or reattach the watchdog, depending on <see cref="Properties.Settings.ReattachToDD"/>, and create the <see cref="DiagnosticsDir"/>
/// Setup or reattach the watchdog, depending on <see cref="InstanceConfig.ReattachRequired"/> of <see cref="Config"/>, and create the <see cref="DiagnosticsDir"/>
/// </summary>
void InitDreamDaemon()
{
@@ -155,7 +155,7 @@ namespace TGServerService
}
/// <summary>
/// Either let go of <see cref="Proc"/> for reattachment or terminate it, depending on <see cref="Properties.Settings.ReattachToDD"/>
/// Either let go of <see cref="Proc"/> for reattachment or terminate it, depending on <see cref="InstanceConfig.ReattachRequired"/> of <see cref="Config"/>
/// </summary>
void DisposeDreamDaemon()
{
@@ -500,7 +500,7 @@ namespace TGServerService
/// <summary>
/// Translate the configured <see cref="DreamDaemonSecurity"/> level into a byond command line param
/// </summary>
/// <param name="starting">If <see langword="true"/> bases it's result on <see cref="StartingSecurity"/>, uses <see cref="Properties.Settings.ServerSecurity"/> otherwise</param>
/// <param name="starting">If <see langword="true"/> bases it's result on <see cref="StartingSecurity"/>, uses <see cref="InstanceConfig.Security"/> of <see cref="Config"/> otherwise</param>
/// <returns>"safe", "trusted", or "ultrasafe" depending on the <see cref="DreamDaemonSecurity"/> it checks</returns>
string SecurityWord(bool starting = false)
{
TGServerService/ServerInstance/Repository.cs
+1 -1
View File
@@ -1272,7 +1272,7 @@ namespace TGServerService
}
/// <summary>
/// Runs on the configured <see cref="Properties.Settings.AutoUpdateInterval"/> and tries to <see cref="Update(bool)"/> and <see cref="Compile(bool)"/> the <see cref="ServerInstance"/>
/// Runs on the configured <see cref="InstanceConfig.AutoUpdateInterval"/> of <see cref="Config"/> and tries to <see cref="Update(bool)"/> and <see cref="Compile(bool)"/> the <see cref="ServerInstance"/>
/// </summary>
/// <param name="sender">A <see cref="System.Timers.Timer"/></param>
/// <param name="e">The event arguments</param>
TGServerService/Service.cs
+4 -4
View File
@@ -76,7 +76,7 @@ namespace TGServerService
/// </summary>
ServiceHost serviceHost;
/// <summary>
/// Map of <see cref="InstanceConfig.Name"/> to the respective <see cref=""/>
/// Map of <see cref="InstanceConfig.Name"/> to the respective <see cref="ServiceHost"/> hosting the <see cref="ServerInstance"/>
/// </summary>
IDictionary<string, ServiceHost> hosts;
/// <summary>
@@ -203,9 +203,10 @@ namespace TGServerService
}
/// <summary>
/// Creates a <see cref="ServiceHost"/> for <paramref name="singleton"/> using the default pipe, <see cref="ServiceHost.CloseTimeout"/>, and the configured <see cref="Properties.Settings.RemoteAccessPort"/>
/// Creates a <see cref="ServiceHost"/> for <paramref name="singleton"/> using the default pipe, CloseTimeout for the <see cref="ServiceHost"/>, and the configured <see cref="Properties.Settings.RemoteAccessPort"/>
/// </summary>
/// <param name="singleton">The <see cref="ServiceHost.SingletonInstance"/></param>
/// <param name="endpointPostfix">The URL to access components on the <see cref="ServiceHost"/></param>
/// <returns>The created <see cref="ServiceHost"/></returns>
static ServiceHost CreateHost(object singleton, string endpointPostfix)
{
@@ -302,7 +303,6 @@ namespace TGServerService
/// </summary>
/// <param name="host">The service host to add the component to</param>
/// <param name="typetype">The type of the component</param>
/// <param name="PipePrefix">The URI prefix for accessing the <paramref name="host"/></param>
void AddEndpoint(ServiceHost host, Type typetype)
{
var bindingName = typetype.Name;
@@ -320,7 +320,7 @@ namespace TGServerService
}
/// <summary>
/// Shutsdown the WCF <see cref="host"/> and calls <see cref="IDisposable.Dispose"/> on it's <see cref="ServerInstance"/>
/// Shuts down all active <see cref="ServiceHost"/>s and calls <see cref="IDisposable.Dispose"/> on it's <see cref="ServerInstance"/>
/// </summary>
protected override void OnStop()
{