Missed files in cleanup (#85)

pubnub · Sep 24, 2024 · e11ca60 · e11ca60
1 parent 8566e2e
commit e11ca60
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git a/pubnub-chat-api/src/commonMain/kotlin/com/pubnub/chat/Event.kt b/pubnub-chat-api/src/commonMain/kotlin/com/pubnub/chat/Event.kt
@@ -19,7 +19,9 @@ interface Event<T : EventContent> {
  val timetoken: Long
 
  /**
- * Data passed in an event (of [EventContent] subtype) that differ depending on the emitted event type ([EventContent.Typing]], [EventContent.Report], [EventContent.Receipt], [EventContent.Mention], [EventContent.Invite], [EventContent.Custom], [EventContent.Moderation], or [EventContent.TextMessageContent]).
+ * Data passed in an event (of [EventContent] subtype) that differs depending on the emitted event type
+ * ([EventContent.Typing]], [EventContent.Report], [EventContent.Receipt], [EventContent.Mention],
+ * [EventContent.Invite], [EventContent.Custom], [EventContent.Moderation], or [EventContent.TextMessageContent]).
  */
  val payload: T
 

diff --git a/pubnub-chat-api/src/commonMain/kotlin/com/pubnub/chat/Membership.kt b/pubnub-chat-api/src/commonMain/kotlin/com/pubnub/chat/Membership.kt
@@ -4,6 +4,9 @@ import com.pubnub.api.models.consumer.pubsub.objects.PNSetMembershipEvent
 import com.pubnub.kmp.CustomObject
 import com.pubnub.kmp.PNFuture
 
+/**
+ * Membership is an object that refers to a single user-channel relationship in a chat.
+ */
 interface Membership {
  /**
  * Reference to the main Chat object.
@@ -88,6 +91,7 @@ interface Membership {
  /**
  * Get a new [Membership] object updated with the values received in the [update].
  *
+ * @param update Data received from the PubNub [com.pubnub.api.v2.callbacks.EventListener.objects] callback.
  * @return A [Membership] updated with values that are present in the [update]
  */
  operator fun plus(update: PNSetMembershipEvent): Membership

diff --git a/pubnub-kotlin b/pubnub-kotlin