Add some generated KDoc.
This commit is contained in:
parent
ddafe50eb5
commit
937f4b81ee
3 changed files with 28 additions and 1 deletions
|
|
@ -38,6 +38,15 @@ import io.element.android.libraries.designsystem.preview.ElementPreviewLight
|
||||||
import io.element.android.libraries.designsystem.theme.LocalColors
|
import io.element.android.libraries.designsystem.theme.LocalColors
|
||||||
import io.element.android.libraries.designsystem.theme.components.Icon
|
import io.element.android.libraries.designsystem.theme.components.Icon
|
||||||
|
|
||||||
|
/**
|
||||||
|
* RoundedIconAtom is an atom which displays an icon inside a rounded container.
|
||||||
|
*
|
||||||
|
* @param modifier the modifier to apply to this layout
|
||||||
|
* @param size the size of the icon
|
||||||
|
* @param resourceId the resource id of the icon to display, exclusive with [imageVector]
|
||||||
|
* @param imageVector the image vector of the icon to display, exclusive with [resourceId]
|
||||||
|
* @param tint the tint to apply to the icon
|
||||||
|
*/
|
||||||
@Composable
|
@Composable
|
||||||
fun RoundedIconAtom(
|
fun RoundedIconAtom(
|
||||||
modifier: Modifier = Modifier,
|
modifier: Modifier = Modifier,
|
||||||
|
|
|
||||||
|
|
@ -38,7 +38,14 @@ import io.element.android.libraries.designsystem.preview.ElementPreviewLight
|
||||||
import io.element.android.libraries.designsystem.theme.components.Text
|
import io.element.android.libraries.designsystem.theme.components.Text
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Provide either an `iconResourceId` or an `iconImageVector`.
|
* IconTitleSubtitleMolecule is a molecule which displays an icon, a title and a subtitle.
|
||||||
|
*
|
||||||
|
* @param title the title to display
|
||||||
|
* @param subTitle the subtitle to display
|
||||||
|
* @param modifier the modifier to apply to this layout
|
||||||
|
* @param iconResourceId the resource id of the icon to display, exclusive with [iconImageVector]
|
||||||
|
* @param iconImageVector the image vector of the icon to display, exclusive with [iconResourceId]
|
||||||
|
* @param iconTint the tint to apply to the icon
|
||||||
*/
|
*/
|
||||||
@Composable
|
@Composable
|
||||||
fun IconTitleSubtitleMolecule(
|
fun IconTitleSubtitleMolecule(
|
||||||
|
|
|
||||||
|
|
@ -30,6 +30,17 @@ import androidx.compose.ui.tooling.preview.Preview
|
||||||
import io.element.android.libraries.designsystem.preview.ElementThemedPreview
|
import io.element.android.libraries.designsystem.preview.ElementThemedPreview
|
||||||
import io.element.android.libraries.designsystem.preview.PreviewGroup
|
import io.element.android.libraries.designsystem.preview.PreviewGroup
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Icon is a wrapper around [androidx.compose.material3.Icon] which allows to use
|
||||||
|
* [ImageVector], [ImageBitmap] or [DrawableRes] as icon source.
|
||||||
|
*
|
||||||
|
* @param contentDescription the content description to be used for accessibility
|
||||||
|
* @param modifier the modifier to apply to this layout
|
||||||
|
* @param tint the tint to apply to the icon
|
||||||
|
* @param imageVector the image vector of the icon to display, exclusive with [bitmap] and [resourceId]
|
||||||
|
* @param bitmap the bitmap of the icon to display, exclusive with [imageVector] and [resourceId]
|
||||||
|
* @param resourceId the resource id of the icon to display, exclusive with [imageVector] and [bitmap]
|
||||||
|
*/
|
||||||
@Composable
|
@Composable
|
||||||
fun Icon(
|
fun Icon(
|
||||||
contentDescription: String?,
|
contentDescription: String?,
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue