Merge pull request #37 from thisIsTheFoxe/update/docs

Update Documentation
AntonyCorbett · Dec 15, 2020 · 7a8d603 · 7a8d603
2 parents 70c4dc3 + c00d207
commit 7a8d603
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 5 deletions.
diff --git a/JWLMerge.BackupFileServices/Models/DatabaseModels/Bookmark.cs b/JWLMerge.BackupFileServices/Models/DatabaseModels/Bookmark.cs
@@ -36,8 +36,8 @@ public class Bookmark
         public string Snippet { get; set; }
 
         /// <summary>
-        /// The block type.
-        /// 0 = Bible chapter?
+        /// The block type. Compare Locations.cs > BlockType
+        /// 0 = Publication 'page' (e.g. a song in the song book)
         /// 1 = Publication paragraph
         /// 2 = Bible verse
         /// </summary>

diff --git a/JWLMerge.BackupFileServices/Models/DatabaseModels/Location.cs b/JWLMerge.BackupFileServices/Models/DatabaseModels/Location.cs
@@ -36,7 +36,7 @@ public class Location
         public int IssueTagNumber { get; set; }
 
         /// <summary>
-        /// The JWL publication key symbol.
+        /// The JWL publication key symbol (nullable).
         /// </summary>
         public string KeySymbol { get; set; }
 
@@ -49,8 +49,8 @@ public class Location
         /// The type. 
         /// 0 = standard location entry
         /// 1 = reference to a publication (see Bookmark.PublicationLocationId)
-        /// 2 = ?
-        /// 3 = ?
+        /// 2 = music or song
+        /// 3 = video
         /// </summary>
         public int Type { get; set; }
 

diff --git a/JWLMerge.BackupFileServices/Models/DatabaseModels/UserMark.cs b/JWLMerge.BackupFileServices/Models/DatabaseModels/UserMark.cs
@@ -9,6 +9,7 @@ public class UserMark
 
         /// <summary>
         /// The index of the marking (highlight) color.
+        /// yellow = 1, green, blue, pink, orange, purple
         /// </summary>
         public int ColorIndex { get; set; }