Skip to content

Commit

Permalink
[#638] Review: Add dots at the end of params description in KDoc
Browse files Browse the repository at this point in the history
  • Loading branch information
florentmaitre authored and paulinea committed Oct 13, 2023
1 parent 83e5bee commit 24f5dc6
Show file tree
Hide file tree
Showing 44 changed files with 241 additions and 241 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,12 @@ import com.orange.ods.compose.theme.OdsTheme
*
* The top app bar displays information and actions relating to the current screen.
*
* @param title Title displayed in the center of the top app bar
* @param modifier [Modifier] applied to the top app bar
* @param navigationIcon Icon displayed at the start of the top app bar
* @param title Title displayed in the center of the top app bar.
* @param modifier [Modifier] applied to the top app bar.
* @param navigationIcon Icon displayed at the start of the top app bar.
* @param actions Actions displayed at the end of the top app bar. The default layout here is a [androidx.compose.foundation.layout.Row], so icons inside will be placed horizontally.
* @param overflowMenuActions Actions displayed in the overflow menu
* @param scrollBehavior [TopAppBarScrollBehavior] attached to the top app bar
* @param overflowMenuActions Actions displayed in the overflow menu.
* @param scrollBehavior [TopAppBarScrollBehavior] attached to the top app bar.
*/
@OptIn(ExperimentalMaterial3Api::class)
@Composable
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,12 @@ import com.orange.ods.compose.theme.OdsTheme
* centering the title, use the other TopAppBar overload for a generic TopAppBar with no
* restriction on content.
*
* @param title Title displayed in the center of the top app bar
* @param modifier [Modifier] applied to the top app bar
* @param navigationIcon Icon displayed at the start of the top app bar
* @param title Title displayed in the center of the top app bar.
* @param modifier [Modifier] applied to the top app bar.
* @param navigationIcon Icon displayed at the start of the top app bar.
* @param actions Actions displayed at the end of the top app bar. The default layout here is a [androidx.compose.foundation.layout.Row], so icons inside will be placed horizontally.
* @param overflowMenuActions Actions displayed in the overflow menu
* @param elevated Controls the elevation of the top app bar: `true` to set an elevation to the top app bar (a shadow is displayed below), `false` otherwise
* @param overflowMenuActions Actions displayed in the overflow menu.
* @param elevated Controls the elevation of the top app bar: `true` to set an elevation to the top app bar (a shadow is displayed below), `false` otherwise.
*/
@Composable
@OdsComposable
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@ import com.orange.ods.compose.theme.OdsTheme
/**
* <a href="https://system.design.orange.com/0c1af118d/p/19a040-banners/b/497b77" class="external" target="_blank">ODS banners</a>.
*
* @param message Text displayed into the banner
* @param firstButton Principal button displayed in the banner
* @param modifier [Modifier] applied to the banner layout
* @param image Image displayed in the banner in a circle shape
* @param secondButton Secondary button displayed into the banner next to the principal one
* @param message Text displayed into the banner.
* @param firstButton Principal button displayed in the banner.
* @param modifier [Modifier] applied to the banner layout.
* @param image Image displayed in the banner in a circle shape.
* @param secondButton Secondary button displayed into the banner next to the principal one.
*/
@Composable
@OdsComposable
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ import com.orange.ods.compose.theme.OdsTheme
* See [OdsBottomNavigationItem] for configuration specific to each item, and not the overall
* OdsBottomNavigation component.
*
* @param modifier [Modifier] applied to the bottom navigation
* @param items List of [OdsBottomNavigationItem] displayed into the bottom navigation
* @param modifier [Modifier] applied to the bottom navigation.
* @param items List of [OdsBottomNavigationItem] displayed into the bottom navigation.
*/
@Composable
@OdsComposable
Expand Down Expand Up @@ -76,12 +76,12 @@ fun OdsBottomNavigation(
* An OdsBottomNavigationItem always shows text labels (if it exists) when selected. Showing text
* labels if not selected is controlled by [alwaysShowLabel].
*
* @param selected whether this item is selected
* @param onClick the callback to be invoked when this item is selected
* @param icon icon for this item
* @param selected whether this item is selected.
* @param onClick the callback to be invoked when this item is selected.
* @param icon icon for this item.
* @param enabled controls the enabled state of this item. When `false`, this item will not
* be clickable and will appear disabled to accessibility services.
* @param label optional text label for this item
* @param label optional text label for this item.
* @param alwaysShowLabel whether to always show the label for this item. If false, the label will
* only be shown when this item is selected.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,16 +32,16 @@ import com.orange.ods.compose.theme.OdsTheme
*
* Bottom Sheets are surfaces anchored to the bottom of the screen that present users supplement content.
*
* @param sheetContent The content of the bottom sheet
* @param modifier optional [Modifier] for this OdsBottomSheetScaffold
* @param scaffoldState The state of the scaffold
* @param topBar An optional top app bar
* @param snackbarHost The composable hosting the snackbars shown inside the scaffold
* @param floatingActionButton An optional floating action button
* @param floatingActionButtonPosition The position of the floating action button
* @param sheetGesturesEnabled Whether the bottom sheet can be interacted with by gestures
* @param sheetPeekHeight The height of the bottom sheet when it is collapsed
* @param content destinations inside this OdsBottomSheetScaffold
* @param sheetContent The content of the bottom sheet.
* @param modifier optional [Modifier] for this OdsBottomSheetScaffold.
* @param scaffoldState The state of the scaffold.
* @param topBar An optional top app bar.
* @param snackbarHost The composable hosting the snackbars shown inside the scaffold.
* @param floatingActionButton An optional floating action button.
* @param floatingActionButtonPosition The position of the floating action button.
* @param sheetGesturesEnabled Whether the bottom sheet can be interacted with by gestures.
* @param sheetPeekHeight The height of the bottom sheet when it is collapsed.
* @param content destinations inside this OdsBottomSheetScaffold.
*/
@Composable
@ExperimentalMaterialApi
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,12 +56,12 @@ enum class OdsButtonStyle {
* Contained buttons are high-emphasis, distinguished by their use of elevation and fill. They
* contain actions that are primary to your app.
*
* @param text Text displayed into the button
* @param onClick Callback invoked when the button is clicked
* @param modifier [Modifier] applied to the button
* @param icon Icon displayed in the button before the text
* @param text Text displayed into the button.
* @param onClick Callback invoked when the button is clicked.
* @param modifier [Modifier] applied to the button.
* @param icon Icon displayed in the button before the text.
* @param enabled Controls the enabled state of the button. When `false`, this button will not be clickable.
* @param style Style applied to the button. Set it to [OdsButtonStyle.Primary] for an highlighted button style or use
* @param style Style applied to the button. Set it to [OdsButtonStyle.Primary] for an highlighted button style or use.
* [OdsButtonStyle.FunctionalPositive]/[OdsButtonStyle.FunctionalNegative] for a functional green/red button style.
* @param displaySurface [OdsDisplaySurface] applied to the button. It allows to force the button display on light or dark surface.
* By default the appearance applied is based on the system night mode value.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@ private val FabIconSize = 24.dp
*
* @see androidx.compose.material.FloatingActionButton for further information.
*
* @param icon Icon used into the FAB
* @param onClick Callback invoked on FAB click
* @param modifier [Modifier] applied to the FAB
* @param icon Icon used into the FAB.
* @param onClick Callback invoked on FAB click.
* @param modifier [Modifier] applied to the FAB.
* @param mini Controls the size of the FAB. If `true`, the size of the FAB will be 40dp, otherwise the default size will be used.
*/
@Composable
Expand Down Expand Up @@ -81,10 +81,10 @@ fun OdsFloatingActionButton(
*
* @see androidx.compose.material.ExtendedFloatingActionButton for further information.
*
* @param icon Icon used into the FAB
* @param onClick Callback invoked on FAB click
* @param text Text displayed into the FAB
* @param modifier [Modifier] applied to the FAB
* @param icon Icon used into the FAB.
* @param onClick Callback invoked on FAB click.
* @param text Text displayed into the FAB.
* @param modifier [Modifier] applied to the FAB.
*/
@Composable
@OdsComposable
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ import com.orange.ods.compose.theme.OdsDisplaySurface
*
* This component is typically used inside an App Bar for the navigation icon / actions.
*
* @param icon Icon to be drawn into the button
* @param onClick Callback to be invoked when the button is clicked
* @param modifier [Modifier] to be applied to the button
* @param icon Icon to be drawn into the button.
* @param onClick Callback to be invoked when the button is clicked.
* @param modifier [Modifier] to be applied to the button.
* @param enabled Controls the enabled state of the button. When `false`, this button will not be clickable.
* @param displaySurface [OdsDisplaySurface] to be applied to the button. It allows to force the button display on light or dark surface. By default, the appearance applied is based on the system night mode value.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ import com.orange.ods.compose.theme.OdsDisplaySurface
* An [IconButton] with two states, for icons that can be toggled 'on' and 'off', such as a
* bookmark icon, or a navigation icon that opens a drawer.
*
* @param checked Controls the checked state of the button
* @param onCheckedChange Callback invoked when the button is checked
* @param uncheckedIcon Icon displayed when the button is unchecked
* @param checkedIcon Icon displayed when the button is checked
* @param modifier [Modifier] applied to the button
* @param checked Controls the checked state of the button.
* @param onCheckedChange Callback invoked when the button is checked.
* @param uncheckedIcon Icon displayed when the button is unchecked.
* @param checkedIcon Icon displayed when the button is checked.
* @param modifier [Modifier] applied to the button.
* @param enabled Controls the enabled state of the button. When `false`, this button will not be clickable.
* @param displaySurface [OdsDisplaySurface] applied to the button. It allows to force the button display on light or dark surface. By default, the appearance applied is based on the system night mode value.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,10 @@ import com.orange.ods.compose.utilities.extension.enable
* A group of toggle buttons. Only one option in a group of toggle buttons can be selected and active at a time.
* Selecting one option deselects any other.
*
* @param icons List of [OdsIconToggleButtonsRowIcon] displayed into the toggle group
* @param selectedIndex [icons] list index of the selected button
* @param onSelectedIndexChange Callback invoked on selection change
* @param modifier [Modifier] applied to the toggle buttons group
* @param icons List of [OdsIconToggleButtonsRowIcon] displayed into the toggle group.
* @param selectedIndex [icons] list index of the selected button.
* @param onSelectedIndexChange Callback invoked on selection change.
* @param modifier [Modifier] applied to the toggle buttons group.
* @param displaySurface [OdsDisplaySurface] applied to the button. It allows to force the button display on light or dark surface. By default, the
* appearance applied is based on the system night mode value.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,10 @@ import com.orange.ods.theme.colors.OdsColors
* Outlined buttons are medium-emphasis buttons. They contain actions that are important, but aren't
* the primary action in an app.
*
* @param text Text displayed into the button
* @param onClick Callback invoked on button click
* @param modifier [Modifier] applied to the button
* @param icon Icon displayed in the button before the text
* @param text Text displayed into the button.
* @param onClick Callback invoked on button click.
* @param modifier [Modifier] applied to the button.
* @param icon Icon displayed in the button before the text.
* @param enabled Controls the enabled state of the button. When `false`, the button is not clickable.
* @param displaySurface [OdsDisplaySurface] applied to the button. It allows to force the button display on light or dark surface. By default, the
* appearance applied is based on the system night mode value.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,10 @@ enum class OdsTextButtonStyle {
* Text buttons are typically used for less-pronounced actions, including those located in dialogs
* and cards. In cards, text buttons help maintain an emphasis on card content.
*
* @param text Text displayed into the button
* @param onClick Callback invoked on button click
* @param modifier [Modifier] applied to the button
* @param icon Icon displayed in the button before the text
* @param text Text displayed into the button.
* @param onClick Callback invoked on button click.
* @param modifier [Modifier] applied to the button.
* @param icon Icon displayed in the button before the text.
* @param enabled Controls the enabled state of the button. When `false`, this button will not be clickable.
* @param style Style applied to the button. By default `onSurface` color is used for text color. Use [OdsTextButtonStyle.Primary] for an highlighted
* text color.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,10 @@ import com.orange.ods.compose.theme.OdsDisplaySurface
* A group of toggle buttons. Only one option in a group of toggle buttons can be selected and active at a time.
* Selecting one option deselects any other.
*
* @param textToggleButtons List of [OdsTextToggleButtonsRowItem] displayed into the toggle group
* @param selectedIndex [textToggleButtons] list index of the selected button
* @param onSelectedIndexChange Callback invoked on selection change
* @param modifier [Modifier] applied to the toggle buttons row
* @param textToggleButtons List of [OdsTextToggleButtonsRowItem] displayed into the toggle group.
* @param selectedIndex [textToggleButtons] list index of the selected button.
* @param onSelectedIndexChange Callback invoked on selection change.
* @param modifier [Modifier] applied to the toggle buttons row.
* @param sameItemsWeight Controls the place occupied by each item. When `true`, same weight of importance will be applied to each item, they will occupy
* the same width.
* @param displaySurface [OdsDisplaySurface] applied to the button. It allows to force the button display on light or dark surface. By default,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,16 +41,16 @@ import com.orange.ods.compose.theme.OdsTheme
*
* Cards contain content and actions about a single subject.
*
* @param title Title displayed into the card
* @param image [OdsCardImage] displayed into the card
* @param modifier [Modifier] applied to the layout of the card
* @param subtitle Subtitle displayed into the card
* @param text Text displayed into the card
* @param firstButton First [OdsCardButton] displayed into the card
* @param secondButton Second [OdsCardButton] displayed into the card
* @param title Title displayed into the card.
* @param image [OdsCardImage] displayed into the card.
* @param modifier [Modifier] applied to the layout of the card.
* @param subtitle Subtitle displayed into the card.
* @param text Text displayed into the card.
* @param firstButton First [OdsCardButton] displayed into the card.
* @param secondButton Second [OdsCardButton] displayed into the card.
* @param imagePosition Position of the image within the card, it can be set to `OdsHorizontalCardImagePosition.Start` or `OdsHorizontalCardImagePosition.End`. [OdsHorizontalCardImagePosition.Start] by default.
* @param divider Controls the divider display. If `true`, it will be displayed between the card content and the action buttons.
* @param onClick Callback invoked on card click
* @param onClick Callback invoked on card click.
*/
@Composable
@OdsComposable
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@ import com.orange.ods.compose.theme.OdsTheme
*
* Cards contain content and actions about a single subject.
*
* @param title Title displayed into the card
* @param image [OdsCardImage] displayed into the card
* @param modifier [Modifier] applied to the layout of the card
* @param subtitle Subtitle displayed into the card
* @param onClick Callback invoked on card click
* @param title Title displayed into the card.
* @param image [OdsCardImage] displayed into the card.
* @param modifier [Modifier] applied to the layout of the card.
* @param subtitle Subtitle displayed into the card.
* @param onClick Callback invoked on card click.
*/
@Composable
@OdsComposable
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,15 @@ import com.orange.ods.extension.orElse
*
* Cards contain content and actions about a single subject.
*
* @param title Title displayed into the card
* @param image [OdsCardImage] displayed into the card
* @param modifier [Modifier] applied to the layout of the card
* @param thumbnail [OdsCardThumbnail] displayed into the card next to the title: avatar, logo or icon
* @param subtitle Subtitle displayed into the card
* @param text Text displayed into the card
* @param firstButton First [OdsCardButton] displayed into the card
* @param secondButton Second [OdsCardButton] displayed into the card
* @param onClick Callback invoked on card click
* @param title Title displayed into the card.
* @param image [OdsCardImage] displayed into the card.
* @param modifier [Modifier] applied to the layout of the card.
* @param thumbnail [OdsCardThumbnail] displayed into the card next to the title: avatar, logo or icon.
* @param subtitle Subtitle displayed into the card.
* @param text Text displayed into the card.
* @param firstButton First [OdsCardButton] displayed into the card.
* @param secondButton Second [OdsCardButton] displayed into the card.
* @param onClick Callback invoked on card click.
*/
@Composable
@OdsComposable
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,14 @@ import com.orange.ods.compose.text.OdsTextSubtitle2
*
* Cards contain content and actions about a single subject.
*
* @param title Title displayed into the card
* @param image [OdsCardImage] displayed into the card
* @param modifier [Modifier] applied to the layout of the card
* @param subtitle Subtitle displayed into the card
* @param text Text displayed into the card
* @param firstButton First [OdsCardButton] displayed into the card
* @param secondButton Second [OdsCardButton] displayed into the card
* @param onClick Callback invoked on card click
* @param title Title displayed into the card.
* @param image [OdsCardImage] displayed into the card.
* @param modifier [Modifier] applied to the layout of the card.
* @param subtitle Subtitle displayed into the card.
* @param text Text displayed into the card.
* @param firstButton First [OdsCardButton] displayed into the card.
* @param secondButton Second [OdsCardButton] displayed into the card.
* @param onClick Callback invoked on card click.
*/
@Composable
@OdsComposable
Expand Down
Loading

0 comments on commit 24f5dc6

Please sign in to comment.