Update doc

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/room/create/CreateLocalRoomStateEventsTask.kt

@@ -55,6 +55,13 @@ import org.matrix.android.sdk.internal.task.Task
 import org.matrix.android.sdk.internal.util.time.Clock
 import javax.inject.Inject
 
+/**
+ * Generate a list of local state events from the given [CreateRoomBody].
+ * The states events are generated according to the given configuration and following the matrix specification.
+ * This list reflects as much as possible a list of state events related to a real room configured and got from the server.
+ *
+ * Ref: https://spec.matrix.org/latest/client-server-api/#post_matrixclientv3createroom
+ */
 internal interface CreateLocalRoomStateEventsTask : Task<Params, List<Event>> {
     data class Params(
             val roomCreatorUserId: String,
@@ -74,6 +81,8 @@ internal class DefaultCreateLocalRoomStateEventsTask @Inject constructor(
         createRoomBody = params.createRoomBody
         roomCreatorUserId = params.roomCreatorUserId
 
+        // Build the list of the state events following the priorities from the matrix specification
+        // Changing the order of the events might break the correct display of the room on the client side
         return buildList {
             createRoomCreateEvent()
             createRoomMemberEvents(listOf(roomCreatorUserId))

matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/room/create/CreateRoomFromLocalRoomTask.kt

@@ -53,11 +53,11 @@ import java.util.concurrent.TimeUnit
 import javax.inject.Inject
 
 /**
- * Create a Room from a "fake" local room.
+ * Create a room on the server from a local room.
  * The configuration of the local room will be use to configure the new room.
  * The potential local room members will also be invited to this new room.
  *
- * A "fake" local tombstone event will be created to indicate that the local room has been replacing by the new one.
+ * A local tombstone event will be created to indicate that the local room has been replacing by the new one.
  */
 internal interface CreateRoomFromLocalRoomTask : Task<CreateRoomFromLocalRoomTask.Params, String> {
     data class Params(val localRoomId: String)