ReSharper: -WaterMeterCore

Common/Hardware/WaterMeter/WaterMeterCore/Consts/DisplayCodes.cs

@@ -1,40 +1,100 @@
 namespace Xylem.Common.Hardware.WaterMeter.WaterMeterCore.Consts
 {
+    /// <summary>
+    /// Display codes to keep the user informed about the production and processing step.
+    /// This is useful as the user doesn't need to connect the device to a PC, he can
+    /// immediately inspect the status of the device.
+    /// </summary>
     public enum DisplayCodes
     {
-        //general
+        //general information
+        /// <summary>
+        /// Status not set
+        /// </summary>
         None = 0x0000,
+        /// <summary>
+        /// Error state
+        /// </summary>
         Error = 0xFFFF,
 
 
-        //Production proccess
+        //Production process
             //assembly line 
                 //Picking
+                /// <summary>
+                /// Picking in progress
+                /// </summary>
                 PickingStarted = 0x7700,
+                /// <summary>
+                /// Picking succeeded, next step can be initiated
+                /// </summary>
                 PickingTested = 0x7777,
+                /// <summary>
+                /// Picking failed
+                /// </summary>
                 PickingFailed = 0xFF77,
 
                 //Pressure
+                /// <summary>
+                /// Pressure testing succeeded, next step can be initiated
+                /// </summary>
                 PressureTested = 0x1111,
+                /// <summary>
+                /// Pressure test failed
+                /// </summary>
                 PressureTestedFailed = 0xFF11,
 
                 //Marriage
+                /// <summary>
+                /// Connection between PCBID, Serial Number and Order number done 
+                /// </summary>
                 Mounted = 0x2222,
 
-            //Testbench
+            //Test bench
+                /// <summary>
+                /// Zero flow test succeeded, next step can be initiated
+                /// </summary>
                 ZeroFlow = 0x3333,
+                /// <summary>
+                /// Zero flow test failed
+                /// </summary>
                 ZeroFlowFailed = 0xFF33,
+                /// <summary>
+                /// Flow calibration succeeded, next step can be initiated
+                /// </summary>
                 FlowCalibrated = 0x4444,
+                /// <summary>
+                /// Flow calibration failed
+                /// </summary>
                 FlowCalibrationOurOfRange = 0xFF44,
+                /// <summary>
+                /// Flow test succeeded, next step can be initiated
+                /// </summary>
                 FlowTested = 0x5555,
+                /// <summary>
+                /// Flow test failed
+                /// </summary>
                 FlowTestFailed = 0xFF55,
 
             //End of line / final test
+            /// <summary>
+            /// Final test failed, else the display will be switched to operational mode,
+            /// showing the actual accumulated volume
+            /// </summary>
             FinalTestFailed = 0xFF66,
 
         //FWUpdate
+        /// <summary>
+        /// FW update is ongoing
+        /// </summary>
         FwUpdateActive = 0x8888,
+        /// <summary>
+        /// FW update failed
+        /// </summary>
         FwUpdateFailed = 0xFF88,
+        /// <summary>
+        /// FW update succeeded
+        /// </summary>
         FwUpToDate = 0x9999,
     }
 }