Fix remaining documentation errors

This commit is contained in:
Cyberboss
2017-10-19 12:32:39 -04:00
parent 1812841748
commit 601f39b269
11 changed files with 25 additions and 20 deletions
+1 -1
View File
@@ -207,7 +207,7 @@ namespace TGCommandLine
}
protected override ExitCode Run(IList<string> parameters)
{
var result = Server.GetComponent<ITGRepository>().PushChangelog();
var result = Server.GetComponent<ITGRepository>().SynchronizePush();
if(result != null)
OutputProc(result);
return result == null ? ExitCode.Normal : ExitCode.ServerError;
+1 -1
View File
@@ -118,7 +118,7 @@ namespace TGCommandLine
OutputProc(res);
else
{
res = Repo.PushChangelog();
res = Repo.SynchronizePush();
if (res != null)
OutputProc(res);
}
+2 -2
View File
@@ -4,10 +4,10 @@ using TGServiceInterface;
namespace TGControlPanel
{
public partial class Login : Form
partial class Login : Form
{
/// <summary>
/// Create a <see cref="Login"/>
/// Create a <see cref="Login"/> form
/// </summary>
public Login()
{
+1 -1
View File
@@ -8,7 +8,7 @@ namespace TGControlPanel
/// <summary>
/// The main <see cref="TGControlPanel"/> form
/// </summary>
public partial class Main : Form
partial class Main : Form
{
/// <summary>
/// Create the control panel. Requires the <see cref="Server"/> has had it's connection info setup
+3 -3
View File
@@ -388,7 +388,7 @@ namespace TGControlPanel
{
Repo.GenerateChangelog(out updateError);
if (updateError == null)
updateError = Repo.PushChangelog();
updateError = Repo.SynchronizePush();
updateError = DM.Compile(true) ? updateError : "Compilation failed!";
}
break;
@@ -398,7 +398,7 @@ namespace TGControlPanel
{
Repo.GenerateChangelog(out updateError);
if (updateError == null)
updateError = Repo.PushChangelog();
updateError = Repo.SynchronizePush();
updateError = Repo.MergePullRequest(testmergePR);
if (updateError == null)
{
@@ -413,7 +413,7 @@ namespace TGControlPanel
{
Repo.GenerateChangelog(out updateError);
if (updateError == null)
Repo.PushChangelog(); //not an error 99% of the time if this fails, just a dirty tree
Repo.SynchronizePush(); //not an error 99% of the time if this fails, just a dirty tree
updateError = DM.Compile(true) ? updateError : "Compilation failed!";
}
break;
+1 -1
View File
@@ -10,7 +10,7 @@ using System.Windows.Forms;
namespace TGInstallerWrapper
{
public partial class Main : Form
partial class Main : Form
{
const string DefaultInstallDir = "TG Station Server"; //keep this in sync with the msi installer
+1 -1
View File
@@ -943,7 +943,7 @@ namespace TGServerService
}
}
public string PushChangelog()
public string SynchronizePush()
{
var Config = new RepoConfig(false);
if (Config == null)
+1 -1
View File
@@ -8,7 +8,7 @@ using TGServiceInterface;
namespace TGServerService
{
public partial class TGServerService : ServiceBase
partial class TGServerService : ServiceBase
{
//only deprecate events, do not reuse them
public enum EventID
+13 -6
View File
@@ -59,8 +59,21 @@ namespace TGServiceInterface
const int GameChannelIndex = 5;
const int ProviderIndex = 6;
const int EnabledIndex = 7;
/// <summary>
/// Starting index of <see cref="DataFields"/> which child classes should use to write their custom data to
/// </summary>
protected const int BaseIndex = 8;
/// <summary>
/// Set to <see langword="true"/> if a child constructor should use the baseInfo parameter of <see cref="TGChatSetupInfo.TGChatSetupInfo(TGChatSetupInfo, int)"/> to initialize it's property fields, <see langword="false"/> otherwise
/// </summary>
protected readonly bool InitializeFields;
/// <summary>
/// Raw access to the underlying data
/// </summary>
[DataMember]
public IList<string> DataFields { get; protected set; }
/// <summary>
/// Constructs a <see cref="TGChatSetupInfo"/> from optional <paramref name="baseInfo"/>
/// </summary>
@@ -222,12 +235,6 @@ namespace TGServiceInterface
get { return (TGChatProvider)Convert.ToInt32(DataFields[ProviderIndex]); }
set { DataFields[ProviderIndex] = Convert.ToString((int)value); }
}
/// <summary>
/// Raw access to the underlying data
/// </summary>
[DataMember]
public IList<string> DataFields { get; protected set; }
}
/// <summary>
+1 -1
View File
@@ -34,7 +34,7 @@ namespace TGServiceInterface
/// <summary>
/// Sets up the symlinks for hotswapping game code. This will reset everything in the Game folder. Requires the repository to be set up and locks it once the compilation stage starts. Runs asyncronously from this call
/// </summary>
/// <returns><see if the operation began, false if it could not start</returns>
/// <returns><see langword="true"/> if the operation began, <see langword="false"/> if it could not start</returns>
[OperationContract]
bool Initialize();
-2
View File
@@ -80,8 +80,6 @@ namespace TGServiceInterface
/// Sets the function called when a remote login fails due to the server having an invalid SSL cert
/// </summary>
/// <param name="handler">The <see cref="Func{T, TResult}"/> to be called when a remote login is attempted while the server posesses a bad certificate. Passed a <see cref="string"/> of error information about the and should return <see langword="true"/> if it the connection should be made anyway</param>
/// </summary>
/// <param name="handler"></param>
public static void SetBadCertificateHandler(Func<string, bool> handler)
{
ServicePointManager.ServerCertificateValidationCallback = (sender, cert, chain, error) =>