Some more documentation

Author: sofakingforever

analytics/src/main/java/com/sofakingforever/analytics/events/ContentViewEvent.kt

@@ -3,6 +3,10 @@ package com.sofakingforever.analytics.events
 import com.sofakingforever.analytics.AnalyticsKit
 import com.sofakingforever.analytics.events.base.Event
 
+/**
+ * Implement this interface in your class, if it is a ContentView event.
+ * It will only have a name. nothing else.
+ */
 interface ContentViewEvent : Event {
 
     fun getViewName(kit : AnalyticsKit): String

analytics/src/main/java/com/sofakingforever/analytics/events/CustomEvent.kt

@@ -3,6 +3,12 @@ package com.sofakingforever.analytics.events
 import com.sofakingforever.analytics.AnalyticsKit
 import com.sofakingforever.analytics.events.base.Event
 
+/**
+ * Implement this interface in your class, if it is a "custom" event.
+ *
+ * It will carry a name, and a parameter map.
+ * Both might vary, according to the kit parameter supplied.
+ */
 interface CustomEvent : Event {
 
     fun getEventName(kit: AnalyticsKit): String

analytics/src/main/java/com/sofakingforever/analytics/events/InviteEvent.kt

@@ -3,6 +3,10 @@ package com.sofakingforever.analytics.events
 import android.content.Context
 import com.sofakingforever.analytics.events.base.Event
 
+
+/**
+ * Implement this interface in your class, if it is an Invite event.
+ */
 interface InviteEvent : Event {
 
     val context: Context

analytics/src/main/java/com/sofakingforever/analytics/events/base/Event.kt

@@ -3,9 +3,25 @@ package com.sofakingforever.analytics.events.base
 import com.sofakingforever.analytics.AnalyticsKit
 
 /**
- * Every event interface (See CustomEvent or ContentViewEvent) should extend this interface.
+ * Every event interface should extend this interface. (See CustomEvent or ContentViewEvent)
+ *
+ * @property excludedKits - if you want to disable a certain kit for an event, you just add the kit to this list.
+ * @property includedKits - if you want to send the event to ceratin services, but not other, just add them here.
  */
 interface Event {
+
+
+    val excludedKits: List<AnalyticsKit>
+        get() = emptyList()
+
+
+    val includedKits: List<AnalyticsKit>
+        get() = emptyList()
+
+
+    /**
+     * @return false if *kit* is considered "excluded". true if considered "included".
+     */
     fun isConsideredIncluded(kit: AnalyticsKit): Boolean {
 
         if (excludedKits.contains(kit)) {
@@ -22,11 +38,4 @@ interface Event {
         return true
     }
 
-    val excludedKits: List<AnalyticsKit>
-        get() = emptyList()
-
-
-    val includedKits: List<AnalyticsKit>
-        get() = emptyList()
-
 }