Kdoc: remove unnecessary :
This commit is contained in:
parent
e00a9278d5
commit
2a66e03742
@ -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.
|
* 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)"
|
* 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
|
* @param forceMatrixTo whether we should force using matrix.to base URL
|
||||||
*
|
*
|
||||||
* @return the created template
|
* @return the created template
|
||||||
|
@ -71,7 +71,7 @@ interface ReadService {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns a live list of read receipts for a given event.
|
* 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>>
|
fun getEventReadReceiptsLive(eventId: String): LiveData<List<ReadReceipt>>
|
||||||
}
|
}
|
||||||
|
@ -61,7 +61,7 @@ interface SpaceService {
|
|||||||
* Get's information of a space by querying the server.
|
* 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 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 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.
|
* then the parameters given for suggested_only and max_depth must be the same.
|
||||||
*/
|
*/
|
||||||
suspend fun querySpaceChildren(spaceId: String,
|
suspend fun querySpaceChildren(spaceId: String,
|
||||||
|
@ -111,8 +111,8 @@ interface WidgetService {
|
|||||||
/**
|
/**
|
||||||
* Deactivate a widget in a room. It makes sure you have the rights to handle this.
|
* 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 roomId the room where you want to deactivate the widget.
|
||||||
* @param widgetId: the widget to deactivate.
|
* @param widgetId the widget to deactivate.
|
||||||
*/
|
*/
|
||||||
suspend fun destroyRoomWidget(roomId: String, widgetId: String)
|
suspend fun destroyRoomWidget(roomId: String, widgetId: String)
|
||||||
|
|
||||||
|
@ -35,7 +35,7 @@ internal class RoomAvatarResolver @Inject constructor(@UserId private val userId
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Compute the room avatar url.
|
* 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
|
* @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
|
* @return the room avatar url, can be a fallback to a room member avatar or null
|
||||||
*/
|
*/
|
||||||
|
@ -52,8 +52,8 @@ internal class RoomDisplayNameResolver @Inject constructor(
|
|||||||
/**
|
/**
|
||||||
* Compute the room display name.
|
* Compute the room display name.
|
||||||
*
|
*
|
||||||
* @param realm: the current instance of realm
|
* @param realm the current instance of realm
|
||||||
* @param roomId: the roomId to resolve the name of.
|
* @param roomId the roomId to resolve the name of.
|
||||||
* @return the room display name
|
* @return the room display name
|
||||||
*/
|
*/
|
||||||
fun resolve(realm: Realm, roomId: String): RoomName {
|
fun resolve(realm: Realm, roomId: String): RoomName {
|
||||||
|
@ -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 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 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 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.
|
* 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.
|
* 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")
|
@GET(NetworkConstants.URI_API_PREFIX_PATH_V1 + "rooms/{roomId}/hierarchy")
|
||||||
|
@ -75,7 +75,7 @@ internal class DefaultGetWellknownTask @Inject constructor(
|
|||||||
* - validate homeserver url and identity server url if provide in .well-known result
|
* - validate homeserver url and identity server url if provide in .well-known result
|
||||||
* - return action and .well-known data
|
* - 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 {
|
private suspend fun findClientConfig(domain: String, client: OkHttpClient): WellknownResult {
|
||||||
val wellKnownAPI = retrofitFactory.create(client, "https://dummy.org")
|
val wellKnownAPI = retrofitFactory.create(client, "https://dummy.org")
|
||||||
|
Loading…
x
Reference in New Issue
Block a user