From a8df81966bf1379e7549c4d325d75d473168445c Mon Sep 17 00:00:00 2001
From: Michaeljon Miller <michaeljon.miller@outlook.com>
Date: Wed, 18 May 2022 09:54:38 -0700
Subject: [PATCH] issue-8: added missing docs

---
 Models/ReadFlag.cs | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/Models/ReadFlag.cs b/Models/ReadFlag.cs
index 0848cbb..5af2fae 100644
--- a/Models/ReadFlag.cs
+++ b/Models/ReadFlag.cs
@@ -11,46 +11,57 @@ public enum ReadFlag : ushort
         Paired = 1,
 
         /// <summary>
+        /// each segment properly aligned according to the aligner (read mapped in proper pair)
         /// </summary>
         Aligned = 2,
 
         /// <summary>
+        /// segment unmapped (read1 unmapped)
         /// </summary>
         SegmentUnmapped = 4,
 
         /// <summary>
+        /// next segment in the template unmapped (read2 unmapped)
         /// </summary>
         NextSegmentUnmapped = 8,
 
         /// <summary>
+        /// SEQ being reverse complemented (read1 reverse complemented)
         /// </summary>
         ReverseComplemented = 16,
 
         /// <summary>
+        /// SEQ of the next segment in the template being reverse complemented (read2 reverse complemented)
         /// </summary>
         NextSegmentReverseComplemented = 32,
 
         /// <summary>
+        /// the first segment in the template (is read1)
         /// </summary>
         FirstSegment = 64,
 
         /// <summary>
+        /// the last segment in the template (is read2)
         /// </summary>
         LastSegment = 128,
 
         /// <summary>
+        /// not primary alignment
         /// </summary>
         NotPrimaryAlignment = 256,
 
         /// <summary>
+        /// alignment fails quality checks
         /// </summary>
         FailedQualityChecks = 512,
 
         /// <summary>
+        /// PCR or optical duplicate
         /// </summary>
         OpticalDuplicate = 1024,
 
         /// <summary>
+        /// supplementary alignment (e.g. aligner specific, could be a portion of a split read or a tied region)
         /// </summary>
         SupplementaryAlignment = 2048
     }