Merge pull request #1088 from paug/update-doc

Add documentation for `Session.description` and `Venue.description`
paug · Apr 10, 2024 · 216ce81 · 216ce81
2 parents 1a8f4a8 + e705145
commit 216ce81
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/service/graphql/schema.graphqls b/service/graphql/schema.graphqls
@@ -120,6 +120,11 @@ type Venue {
 
   descriptionFr: String!
 
+  """
+   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.
+  """
   description(language: String = "en"): String!
 }
 
@@ -134,6 +139,11 @@ type Session implements Node {
 
   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.
+  """
   description: String
 
   """

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") ?: ""
     }