From a6a4aafa3695f2cef5a8812aa2a467521178225e Mon Sep 17 00:00:00 2001
From: Niko Ehrenfeuchter <nikolaus.ehrenfeuchter@unibas.ch>
Date: Thu, 25 Apr 2019 13:56:26 +0200
Subject: [PATCH] Use a proper docstring for the TxState enum
---
ATxService/AutoTx.cs | 27 +++++++++++++++------------
1 file changed, 15 insertions(+), 12 deletions(-)
diff --git a/ATxService/AutoTx.cs b/ATxService/AutoTx.cs
index bb9b29b..aacdc6c 100644
--- a/ATxService/AutoTx.cs
+++ b/ATxService/AutoTx.cs
@@ -73,24 +73,27 @@ namespace ATxService
private DateTime _lastUserDirCheck = DateTime.MinValue;
- // the transfer state:
+ /// <summary>
+ /// The transfer state, one of "Stopped", "Active", "Paused" or "DoNothing".
+ ///
+ /// Stopped: The last transfer was finished successfully or none was started yet. A new
+ /// transfer MAY ONLY BE STARTED if the service is in this state.
+ ///
+ /// Active: A transfer is currently running (i.e. new transfers MUST NOT be started).
+ ///
+ /// Paused: Assigned in PauseTransfer() which gets called from within RunMainTasks()
+ /// when system parameters are not in their valid range. It gets evaluated if
+ /// the parameters return to valid or if no user is logged on any more.
+ ///
+ /// DoNothing: Assigned when the service gets shut down (in the OnStop() method) to prevent
+ /// accidentially launching new transfers or doing other tasks.
+ /// </summary>
private enum TxState
{
Stopped = 0,
- // Stopped: the last transfer was finished successfully or none was started yet.
- // A new transfer may only be started if the service is in this state.
-
Active = 1,
- // Active: a transfer is currently running (i.e. no new transfer may be started).
-
Paused = 2,
- // Paused is assigned in PauseTransfer() which gets called from within RunMainTasks()
- // when system parameters are not in their valid range. It gets evaluated if the
- // parameters return to valid or if no user is logged on any more.
-
DoNothing = 3
- // DoNothing is assigned when the service gets shut down (in the OnStop() method)
- // to prevent accidentially launching new transfers etc.
}
private TxState _transferState = TxState.Stopped;
--
GitLab