Add comments in API packages

This commit is contained in:
ganfra 2019-01-25 15:44:41 +01:00
parent 9dccad11fe
commit c33e96b82c
14 changed files with 39 additions and 20 deletions

View file

@ -1,18 +0,0 @@
/*
* Copyright 2019 New Vector Ltd
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package im.vector.riotredesign.features.home.room.detail.timeline

View file

@ -16,6 +16,10 @@
package im.vector.matrix.android.api.session.group.model
/**
* This class holds some data of a group.
* It can be retrieved through [im.vector.matrix.android.api.session.group.GroupService]
*/
data class GroupSummary(
val groupId: String,
val displayName: String = "",

View file

@ -18,8 +18,10 @@ package im.vector.matrix.android.api.session.room.model
import com.squareup.moshi.Json
import com.squareup.moshi.JsonClass
import im.vector.matrix.android.api.session.room.Signed
/**
* Subclass representing a search API response
*/
@JsonClass(generateAdapter = true)
data class Invite(
@Json(name = "display_name") val displayName: String,

View file

@ -18,6 +18,9 @@ package im.vector.matrix.android.api.session.room.model
import com.squareup.moshi.Json
/**
* Represents the membership of a user on a room. Linked to a [RoomMember]
*/
enum class Membership(val value: String) {
@Json(name = "invite")

View file

@ -16,6 +16,9 @@
package im.vector.matrix.android.api.session.room.model
/**
* Represents the membership of the current auth user on a room.
*/
enum class MyMembership {
JOINED,
LEFT,

View file

@ -22,6 +22,9 @@ import com.squareup.moshi.JsonClass
import im.vector.matrix.android.api.session.events.model.EventType
import java.util.*
/**
* Class representing the EventType.EVENT_TYPE_STATE_ROOM_POWER_LEVELS state event content.
*/
@JsonClass(generateAdapter = true)
data class PowerLevels(
@Json(name = "ban") val ban: Int = 50,

View file

@ -19,6 +19,9 @@ package im.vector.matrix.android.api.session.room.model
import com.squareup.moshi.Json
import com.squareup.moshi.JsonClass
/**
* Class representing the EventType.STATE_ROOM_ALIASES state event content
*/
@JsonClass(generateAdapter = true)
data class RoomAliasesContent(
@Json(name = "aliases") val aliases: List<String> = emptyList()

View file

@ -19,6 +19,9 @@ package im.vector.matrix.android.api.session.room.model
import com.squareup.moshi.Json
import com.squareup.moshi.JsonClass
/**
* Class representing the EventType.STATE_ROOM_AVATAR state event content
*/
@JsonClass(generateAdapter = true)
data class RoomAvatarContent(
@Json(name = "url") val avatarUrl: String? = null

View file

@ -19,6 +19,9 @@ package im.vector.matrix.android.api.session.room.model
import com.squareup.moshi.Json
import com.squareup.moshi.JsonClass
/**
* Class representing the EventType.STATE_CANONICAL_ALIAS state event content
*/
@JsonClass(generateAdapter = true)
data class RoomCanonicalAliasContent(
@Json(name = "alias") val canonicalAlias: String? = null

View file

@ -20,6 +20,9 @@ import com.squareup.moshi.Json
import com.squareup.moshi.JsonClass
import im.vector.matrix.android.api.session.events.model.UnsignedData
/**
* Class representing the EventType.STATE_ROOM_MEMBER state event content
*/
@JsonClass(generateAdapter = true)
data class RoomMember(
@Json(name = "membership") val membership: Membership,

View file

@ -19,6 +19,9 @@ package im.vector.matrix.android.api.session.room.model
import com.squareup.moshi.Json
import com.squareup.moshi.JsonClass
/**
* Class representing the EventType.STATE_ROOM_NAME state event content
*/
@JsonClass(generateAdapter = true)
data class RoomNameContent(
@Json(name = "name") val name: String? = null

View file

@ -16,6 +16,10 @@
package im.vector.matrix.android.api.session.room.model
/**
* This class holds some data of a room.
* It can be retrieved by [im.vector.matrix.android.api.session.room.Room] and [im.vector.matrix.android.api.session.room.RoomService]
*/
data class RoomSummary(
val roomId: String,
val displayName: String = "",

View file

@ -19,6 +19,9 @@ package im.vector.matrix.android.api.session.room.model
import com.squareup.moshi.Json
import com.squareup.moshi.JsonClass
/**
* Class representing the EventType.STATE_ROOM_TOPIC state event content
*/
@JsonClass(generateAdapter = true)
data class RoomTopicContent(
@Json(name = "topic") val topic: String? = null

View file

@ -14,7 +14,7 @@
* limitations under the License.
*/
package im.vector.matrix.android.api.session.room
package im.vector.matrix.android.api.session.room.model
import com.squareup.moshi.Json