felixfoertsch/bundesmessenger-ios
1
0
Fork 0
mirror of https://gitlab.opencode.de/bwi/bundesmessenger/clients/bundesmessenger-ios.git synced 2026-04-19 16:13:42 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update RiotSwiftUI symbols to triple slash documentation style with function annotations.

Browse Source
This commit is contained in:
David Langley
2021-09-13 11:36:33 +01:00
parent 886bb98eb1
commit 3d65fbd48f
39 changed files with 184 additions and 240 deletions
Download Patch File Download Diff File Expand all files Collapse all files
RiotSwiftUI/Modules/Common/Avatar/Service/MatrixSDK/AvatarService.swift
+7 -8
View File
@@ -41,14 +41,13 @@ class AvatarService: AvatarServiceProtocol {
self.mediaManager = mediaManager
}
/**
Given an mxContentUri, this function returns a Future of UIImage.
If possible it will retrieve the image from network or cache, otherwise it will error.
- Parameter mxContentUri: matrix uri of the avatar to fetch
- Parameter avatarSize: The size of avatar to retrieve as defined in the DesignKit spec.
- Returns: A Future of UIImage that returns an error if it fails to fetch the image
*/
/// Given an mxContentUri, this function returns a Future of UIImage.
///
/// If possible it will retrieve the image from network or cache, otherwise it will error.
/// - Parameters:
/// - mxContentUri: matrix uri of the avatar to fetch
/// - avatarSize: The size of avatar to retrieve as defined in the DesignKit spec.
/// - Returns: A Future of UIImage that returns an error if it fails to fetch the image.
@available(iOS 14.0, *)
func avatarImage(mxContentUri: String, avatarSize: AvatarSize) -> Future<UIImage, Error> {