From b062a17948eeeb444ff2152f173db8dcb81f6012 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Sebastian=20K=C3=BCrten?= <sebastian@mobanisto.de>
Date: Fri, 8 Oct 2021 09:22:39 +0200
Subject: [PATCH] Add docs for ProfileCircle
---
.../briarproject/briar/desktop/paul/views/ProfileCircle.kt | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/src/main/kotlin/org/briarproject/briar/desktop/paul/views/ProfileCircle.kt b/src/main/kotlin/org/briarproject/briar/desktop/paul/views/ProfileCircle.kt
index ae8fd7c1de..c821e0391e 100644
--- a/src/main/kotlin/org/briarproject/briar/desktop/paul/views/ProfileCircle.kt
+++ b/src/main/kotlin/org/briarproject/briar/desktop/paul/views/ProfileCircle.kt
@@ -24,6 +24,11 @@ fun PreviewProfileCircle() {
ProfileCircle(90.dp, bytes)
}
+/**
+ * Display an [Identicon] as a profile image within a circle based on a user's author id.
+ * @param size the size of the circle. In order to avoid aliasing effects, pass a multiple
+ * of 9 here. That helps as the image is based on a 9x9 square grid.
+ */
@Composable
fun ProfileCircle(size: Dp, input: ByteArray) {
Canvas(Modifier.size(size).clip(CircleShape).border(2.dp, MaterialTheme.colors.outline, CircleShape)) {
--
GitLab