From 49a8b1f665d3db8a3975a3cd17ff7fd12cf8d717 Mon Sep 17 00:00:00 2001
From: Gergely Polonkai <gergely@polonkai.eu>
Date: Wed, 9 Mar 2016 16:16:25 +0100
Subject: [PATCH] Add value description to HistoryVisibility

---
 src/matrix-types.vala | 15 ++++++++++-----
 1 file changed, 10 insertions(+), 5 deletions(-)

diff --git a/src/matrix-types.vala b/src/matrix-types.vala
index 729e203..348ff42 100644
--- a/src/matrix-types.vala
+++ b/src/matrix-types.vala
@@ -263,11 +263,16 @@ namespace Matrix {
     }
 
     public enum HistoryVisibility {
-        UNKNOWN,
-        INVITED,
-        JOINED,
-        SHARE,
-        WORLD_READABLE;
+        UNKNOWN,        /// represents a value unknown to this library
+        INVITED,        /// only room members can see the room
+                        /// history, and only what happened after they
+                        /// got an invitation
+        JOINED,         /// only room members can see the room
+                        /// history, and only what happened after they
+                        /// joined
+        SHARED,         /// only room members can see the room
+                        /// history, but they see all of it
+        WORLD_READABLE; /// anyone can see the room history
     }
 
     public enum GuestAccess {