add documentation

paug · Apr 10, 2024 · d2aeada · d2aeada
1 parent 1a8f4a8
commit d2aeada
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/service/src/commonMain/kotlin/androidmakers/service/graphql/model.kt b/service/src/commonMain/kotlin/androidmakers/service/graphql/model.kt
@@ -291,6 +291,11 @@ sealed interface Node {
 data class Session(
     override val id: String,
     val title: String,
+    /**
+     * The description of the event. [description] may contain emojis and '\n' Chars but no markdown or HTML.
+     *
+     * May be null if no description is available.
+     */
     val description: String?,
     /**
      * A shorter version of description for use when real estate is scarce like watches for an example.
@@ -424,6 +429,11 @@ data class Venue(
             return descriptions.get("\"fr\"") ?: descriptions.get("en") ?: ""
         }
 
+    /**
+     * The description of the venue. [description] may contain emojis and '\n' Chars but no markdown or HTML.
+     *
+     * May be null if no description is available.
+     */
     fun description(@GraphQLDefault("\"en\"") language: String?): String {
         return descriptions.get(language) ?: descriptions.get("en") ?: ""
     }