From 2a66e037426fd5aa7c1a55ca035ef8563aa715de Mon Sep 17 00:00:00 2001
From: Benoit Marty <benoit@matrix.org>
Date: Wed, 18 May 2022 08:50:04 +0200
Subject: [PATCH] Kdoc: remove unnecessary `:`
---
.../android/sdk/api/session/permalinks/PermalinkService.kt | 2 +-
.../matrix/android/sdk/api/session/room/read/ReadService.kt | 2 +-
.../matrix/android/sdk/api/session/space/SpaceService.kt | 2 +-
.../matrix/android/sdk/api/session/widgets/WidgetService.kt | 4 ++--
.../android/sdk/internal/session/room/RoomAvatarResolver.kt | 2 +-
.../session/room/membership/RoomDisplayNameResolver.kt | 4 ++--
.../matrix/android/sdk/internal/session/space/SpaceApi.kt | 6 +++---
.../android/sdk/internal/wellknown/GetWellknownTask.kt | 2 +-
8 files changed, 12 insertions(+), 12 deletions(-)
diff --git a/matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/permalinks/PermalinkService.kt b/matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/permalinks/PermalinkService.kt
index b49b80df09..476ded2e16 100644
--- a/matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/permalinks/PermalinkService.kt
+++ b/matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/permalinks/PermalinkService.kt
@@ -90,7 +90,7 @@ interface PermalinkService {
* Creates a HTML or Markdown mention span template. Can be used to replace a mention with a permalink to mentioned user.
* Ex: "<a href=\"https://matrix.to/#/%1\$s\">%2\$s</a>" or "[%2\$s](https://matrix.to/#/%1\$s)"
*
- * @param type: type of template to create
+ * @param type type of template to create
* @param forceMatrixTo whether we should force using matrix.to base URL
*
* @return the created template
diff --git a/matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/read/ReadService.kt b/matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/read/ReadService.kt
index 036628c02f..dac1a1a773 100644
--- a/matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/read/ReadService.kt
+++ b/matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/room/read/ReadService.kt
@@ -71,7 +71,7 @@ interface ReadService {
/**
* Returns a live list of read receipts for a given event.
- * @param eventId: the event
+ * @param eventId the event
*/
fun getEventReadReceiptsLive(eventId: String): LiveData<List<ReadReceipt>>
}
diff --git a/matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/space/SpaceService.kt b/matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/space/SpaceService.kt
index 8f16b3b9c3..2ce00df856 100644
--- a/matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/space/SpaceService.kt
+++ b/matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/space/SpaceService.kt
@@ -61,7 +61,7 @@ interface SpaceService {
* Get's information of a space by querying the server.
* @param suggestedOnly If true, return only child events and rooms where the m.space.child event has suggested: true.
* @param limit a client-defined limit to the maximum number of rooms to return per page. Must be a non-negative integer.
- * @param from: Optional. Pagination token given to retrieve the next set of rooms. Note that if a pagination token is provided,
+ * @param from Optional. Pagination token given to retrieve the next set of rooms. Note that if a pagination token is provided,
* then the parameters given for suggested_only and max_depth must be the same.
*/
suspend fun querySpaceChildren(spaceId: String,
diff --git a/matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/widgets/WidgetService.kt b/matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/widgets/WidgetService.kt
index b06f8f7bc6..8ad6500d25 100644
--- a/matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/widgets/WidgetService.kt
+++ b/matrix-sdk-android/src/main/java/org/matrix/android/sdk/api/session/widgets/WidgetService.kt
@@ -111,8 +111,8 @@ interface WidgetService {
/**
* Deactivate a widget in a room. It makes sure you have the rights to handle this.
*
- * @param roomId: the room where you want to deactivate the widget.
- * @param widgetId: the widget to deactivate.
+ * @param roomId the room where you want to deactivate the widget.
+ * @param widgetId the widget to deactivate.
*/
suspend fun destroyRoomWidget(roomId: String, widgetId: String)
diff --git a/matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/room/RoomAvatarResolver.kt b/matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/room/RoomAvatarResolver.kt
index 29a303475b..c3d55b267a 100644
--- a/matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/room/RoomAvatarResolver.kt
+++ b/matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/room/RoomAvatarResolver.kt
@@ -35,7 +35,7 @@ internal class RoomAvatarResolver @Inject constructor(@UserId private val userId
/**
* Compute the room avatar url.
- * @param realm: the current instance of realm
+ * @param realm the current instance of realm
* @param roomId the roomId of the room to resolve avatar
* @return the room avatar url, can be a fallback to a room member avatar or null
*/
diff --git a/matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/room/membership/RoomDisplayNameResolver.kt b/matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/room/membership/RoomDisplayNameResolver.kt
index 59e0f81ece..9e672dcc5c 100644
--- a/matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/room/membership/RoomDisplayNameResolver.kt
+++ b/matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/room/membership/RoomDisplayNameResolver.kt
@@ -52,8 +52,8 @@ internal class RoomDisplayNameResolver @Inject constructor(
/**
* Compute the room display name.
*
- * @param realm: the current instance of realm
- * @param roomId: the roomId to resolve the name of.
+ * @param realm the current instance of realm
+ * @param roomId the roomId to resolve the name of.
* @return the room display name
*/
fun resolve(realm: Realm, roomId: String): RoomName {
diff --git a/matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/space/SpaceApi.kt b/matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/space/SpaceApi.kt
index d8daa55e15..db3c9c3f5f 100644
--- a/matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/space/SpaceApi.kt
+++ b/matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/session/space/SpaceApi.kt
@@ -25,10 +25,10 @@ internal interface SpaceApi {
/**
* @param suggestedOnly Optional. If true, return only child events and rooms where the m.space.child event has suggested: true.
- * @param limit: Optional: a client-defined limit to the maximum number of rooms to return per page. Must be a non-negative integer.
- * @param maxDepth: Optional: The maximum depth in the tree (from the root room) to return.
+ * @param limit Optional: a client-defined limit to the maximum number of rooms to return per page. Must be a non-negative integer.
+ * @param maxDepth Optional: The maximum depth in the tree (from the root room) to return.
* The deepest depth returned will not include children events. Defaults to no-limit. Must be a non-negative integer.
- * @param from: Optional. Pagination token given to retrieve the next set of rooms.
+ * @param from Optional. Pagination token given to retrieve the next set of rooms.
* Note that if a pagination token is provided, then the parameters given for suggested_only and max_depth must be the same.
*/
@GET(NetworkConstants.URI_API_PREFIX_PATH_V1 + "rooms/{roomId}/hierarchy")
diff --git a/matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/wellknown/GetWellknownTask.kt b/matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/wellknown/GetWellknownTask.kt
index 0d4a5ac28f..c2e9b4e731 100644
--- a/matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/wellknown/GetWellknownTask.kt
+++ b/matrix-sdk-android/src/main/java/org/matrix/android/sdk/internal/wellknown/GetWellknownTask.kt
@@ -75,7 +75,7 @@ internal class DefaultGetWellknownTask @Inject constructor(
* - validate homeserver url and identity server url if provide in .well-known result
* - return action and .well-known data
*
- * @param domain: homeserver domain, deduced from mx userId (ex: "matrix.org" from userId "@user:matrix.org")
+ * @param domain homeserver domain, deduced from mx userId (ex: "matrix.org" from userId "@user:matrix.org")
*/
private suspend fun findClientConfig(domain: String, client: OkHttpClient): WellknownResult {
val wellKnownAPI = retrofitFactory.create(client, "https://dummy.org")