From d9b3f4738b284dd482fc500796e736c402a8c4ab Mon Sep 17 00:00:00 2001
From: Niko Ehrenfeuchter <nikolaus.ehrenfeuchter@unibas.ch>
Date: Fri, 15 Sep 2017 20:25:37 +0200
Subject: [PATCH] Start adding XML docstrings to the config class.
---
AutoTx/XmlConfiguration.cs | 34 ++++++++++++++++++++++++++++++++++
1 file changed, 34 insertions(+)
diff --git a/AutoTx/XmlConfiguration.cs b/AutoTx/XmlConfiguration.cs
index 8c883a2..3b9c74c 100644
--- a/AutoTx/XmlConfiguration.cs
+++ b/AutoTx/XmlConfiguration.cs
@@ -27,13 +27,47 @@ namespace AutoTx
[Serializable]
public class XmlConfiguration
{
+ /// <summary>
+ /// A human friendly name for the host, to be used in emails etc.
+ /// </summary>
public string HostAlias { get; set; }
+
+ /// <summary>
+ /// A human friendly name for the target, to be used in emails etc.
+ /// </summary>
public string DestinationAlias { get; set; }
+
+ /// <summary>
+ /// The base drive for the spooling directories (incoming and managed).
+ /// </summary>
public string SourceDrive { get; set; }
+
+ /// <summary>
+ /// The name of a directory on SourceDrive that is monitored for new files.
+ /// </summary>
public string IncomingDirectory { get; set; }
+
+ /// <summary>
+ /// The name of a marker file to be placed in all **sub**directories
+ /// inside the IncomingDirectory.
+ /// </summary>
public string MarkerFile { get; set; }
+
+ /// <summary>
+ /// A directory on SourceDrive to hold the three subdirectories "DONE",
+ /// "PROCESSING" and "UNMATCHED" used during and after transfers.
+ /// </summary>
public string ManagedDirectory { get; set; }
+
+ /// <summary>
+ /// Target path to transfer files to. Usually a UNC location.
+ /// </summary>
public string DestinationDirectory { get; set; }
+
+ /// <summary>
+ /// The name of a subdirectory in the DestinationDirectory to be used
+ /// to keep the temporary data of running transfers.
+ /// </summary>
public string TmpTransferDir { get; set; }
public string SmtpHost { get; set; }
public string SmtpUserCredential { get; set; }
--
GitLab