Review: Update kdoc

Author: paulinea

core/src/main/java/com/orange/ouds/core/theme/OudsSizes.kt

@@ -42,9 +42,9 @@ data class OudsSizes internal constructor(
      * Sizes for icons depending on their usage context.
      *
      * @property decorative Sizes for standalone decorative icons.
-     * @property withHeading Sizes for icons paired with Heading typography.
-     * @property withLabel Sizes for icons paired with Label typography.
-     * @property withBody Sizes for icons paired with Body typography.
+     * @property withHeading Sizes for icons paired with heading typography.
+     * @property withLabel Sizes for icons paired with label typography.
+     * @property withBody Sizes for icons paired with body typography.
      */
     @ConsistentCopyVisibility
     data class Icon internal constructor(
@@ -80,14 +80,14 @@ data class OudsSizes internal constructor(
         )
 
         /**
-         * Sizes for icons paired with Heading typography.
+         * Sizes for icons paired with heading typography.
          *
-         * The properties correspond to the size of the associated Heading text.
+         * The properties correspond to the size of the associated heading text.
          *
-         * @property small Icons associated with Heading Small.
-         * @property medium Icons associated with Heading Medium.
-         * @property large Icons associated with Heading Large.
-         * @property extraLarge Icons associated with Heading ExtraLarge.
+         * @property small Icons associated with small heading.
+         * @property medium Icons associated with medium heading.
+         * @property large Icons associated with large heading.
+         * @property extraLarge Icons associated with extra large heading.
          */
         @ConsistentCopyVisibility
         data class WithHeading internal constructor(
@@ -96,31 +96,55 @@ data class OudsSizes internal constructor(
             val large: Large,
             val extraLarge: ExtraLarge
         ) {
-            /** Icon sizes for Heading Small. */
+            /**
+             * Icon sizes for small heading.
+             *
+             * @property sizeSmall Small icon size for use with a small heading.
+             * @property sizeMedium Medium icon size for use with a small heading.
+             * @property sizeLarge Large icon size for use with a small heading.
+             */
             @ConsistentCopyVisibility
             data class Small internal constructor(
                 val sizeSmall: Dp,
                 val sizeMedium: Dp,
                 val sizeLarge: Dp,
             )
 
-            /** Icon sizes for Heading Medium. */
+            /**
+             * Icon sizes for medium heading.
+             *
+             * @property sizeSmall Small icon size for use with a medium heading.
+             * @property sizeMedium Medium icon size for use with a medium heading.
+             * @property sizeLarge Large icon size for use with a medium heading.
+             */
             @ConsistentCopyVisibility
             data class Medium internal constructor(
                 val sizeSmall: Dp,
                 val sizeMedium: Dp,
                 val sizeLarge: Dp,
             )
 
-            /** Icon sizes for Heading Large. */
+            /**
+             * Icon sizes for large heading.
+             *
+             * @property sizeSmall Small icon size for use with a large heading.
+             * @property sizeMedium Medium icon size for use with a large heading.
+             * @property sizeLarge Large icon size for use with a large heading.
+             */
             @ConsistentCopyVisibility
             data class Large internal constructor(
                 val sizeSmall: Dp,
                 val sizeMedium: Dp,
                 val sizeLarge: Dp,
             )
 
-            /** Icon sizes for Heading ExtraLarge. */
+            /**
+             * Icon sizes for extra large heading.
+             *
+             * @property sizeSmall Small icon size for use with an extra large heading.
+             * @property sizeMedium Medium icon size for use with an extra large heading.
+             * @property sizeLarge Large icon size for use with an extra large heading.
+             */
             @ConsistentCopyVisibility
             data class ExtraLarge internal constructor(
                 val sizeSmall: Dp,
@@ -130,14 +154,14 @@ data class OudsSizes internal constructor(
         }
 
         /**
-         * Sizes for icons paired with Label typography.
+         * Sizes for icons paired with label typography.
          *
-         * The properties correspond to the size of the associated Label text.
+         * The properties correspond to the size of the associated label text.
          *
-         * @property small Icons associated with Label Small.
-         * @property medium Icons associated with Label Medium.
-         * @property large Icons associated with Label Large.
-         * @property extraLarge Icons associated with Label ExtraLarge.
+         * @property small Icons associated with small labels.
+         * @property medium Icons associated with medium labels.
+         * @property large Icons associated with large labels.
+         * @property extraLarge Icons associated with extra large labels.
          */
         @ConsistentCopyVisibility
         data class WithLabel internal constructor(
@@ -146,7 +170,14 @@ data class OudsSizes internal constructor(
             val large: Large,
             val extraLarge: ExtraLarge
         ) {
-            /** Icon sizes for Label Small. */
+            /**
+             * Icon sizes for small label.
+             *
+             * @property sizeExtraSmall Extra small icon size for use with a small label.
+             * @property sizeSmall Small icon size for use with a small label.
+             * @property sizeMedium Medium icon size for use with a small label.
+             * @property sizeLarge Large icon size for use with a small label.
+             */
             @ConsistentCopyVisibility
             data class Small internal constructor(
                 val sizeExtraSmall: Dp,
@@ -155,7 +186,14 @@ data class OudsSizes internal constructor(
                 val sizeLarge: Dp,
             )
 
-            /** Icon sizes for Label Medium. */
+            /**
+             * Icon sizes for medium label.
+             *
+             * @property sizeExtraSmall Extra small icon size for use with a medium label.
+             * @property sizeSmall Small icon size for use with a medium label.
+             * @property sizeMedium Medium icon size for use with a medium label.
+             * @property sizeLarge Large icon size for use with a medium label.
+             */
             @ConsistentCopyVisibility
             data class Medium internal constructor(
                 val sizeExtraSmall: Dp,
@@ -164,7 +202,15 @@ data class OudsSizes internal constructor(
                 val sizeLarge: Dp,
             )
 
-            /** Icon sizes for Label Large. */
+            /**
+             * Icon sizes for large label.
+             *
+             * @property sizeExtraSmall Extra small icon size for use with a large label.
+             * @property sizeSmall Small icon size for use with a large label.
+             * @property sizeMedium Medium icon size for use with a large label.
+             * @property sizeLarge Large icon size for use with a large label.
+             * @property sizeExtraLarge Extra large icon size for use with a large label.
+             */
             @ConsistentCopyVisibility
             data class Large internal constructor(
                 val sizeExtraSmall: Dp,
@@ -174,7 +220,13 @@ data class OudsSizes internal constructor(
                 val sizeExtraLarge: Dp,
             )
 
-            /** Icon sizes for Label ExtraLarge. */
+            /**
+             * Icon sizes for extra large label.
+             *
+             * @property sizeSmall Small icon size for use with an extra large label.
+             * @property sizeMedium Medium icon size for use with an extra large label.
+             * @property sizeLarge Large icon size for use with an extra large label.
+             */
             @ConsistentCopyVisibility
             data class ExtraLarge internal constructor(
                 val sizeSmall: Dp,
@@ -184,37 +236,55 @@ data class OudsSizes internal constructor(
         }
 
         /**
-         * Sizes for icons paired with Body typography.
+         * Sizes for icons paired with body typography.
          *
-         * The properties correspond to the size of the associated Body text.
+         * The properties correspond to the size of the associated body text.
          *
-         * @property small Icons associated with Body Small.
-         * @property medium Icons associated with Body Medium.
-         * @property large Icons associated with Body Large.
+         * @property small Icons associated with small body.
+         * @property medium Icons associated with medium body.
+         * @property large Icons associated with large body.
          */
         @ConsistentCopyVisibility
         data class WithBody internal constructor(
             val small: Small,
             val medium: Medium,
             val large: Large,
         ) {
-            /** Icon sizes for Body Small. */
+            /**
+             * Icon sizes for small body.
+             *
+             * @property sizeSmall Small icon size for use with small body text.
+             * @property sizeMedium Medium icon size for use with small body text.
+             * @property sizeLarge Large icon size for use with small body text.
+             */
             @ConsistentCopyVisibility
             data class Small internal constructor(
                 val sizeSmall: Dp,
                 val sizeMedium: Dp,
                 val sizeLarge: Dp,
             )
 
-            /** Icon sizes for Body Medium. */
+            /**
+             * Icon sizes for medium body.
+             *
+             * @property sizeSmall Small icon size for use with medium body text.
+             * @property sizeMedium Medium icon size for use with medium body text.
+             * @property sizeLarge Large icon size for use with medium body text.
+             */
             @ConsistentCopyVisibility
             data class Medium internal constructor(
                 val sizeSmall: Dp,
                 val sizeMedium: Dp,
                 val sizeLarge: Dp,
             )
 
-            /** Icon sizes for Body Large. */
+            /**
+             * Icon sizes for large body.
+             *
+             * @property sizeSmall Small icon size for use with large body text.
+             * @property sizeMedium Medium icon size for use with large body text.
+             * @property sizeLarge Large icon size for use with large body text.
+             */
             @ConsistentCopyVisibility
             data class Large internal constructor(
                 val sizeSmall: Dp,
@@ -236,10 +306,10 @@ data class OudsSizes internal constructor(
         /**
          * Max width values grouped by typography type.
          *
-         * @property body Max widths for Body text contexts.
-         * @property display Max widths for Display text contexts.
-         * @property heading Max widths for Heading text contexts.
-         * @property label Max widths for Label text contexts.
+         * @property body Max widths for body text contexts.
+         * @property display Max widths for display text contexts.
+         * @property heading Max widths for heading text contexts.
+         * @property label Max widths for label text contexts.
          */
         @ConsistentCopyVisibility
         data class Type internal constructor(
@@ -248,23 +318,42 @@ data class OudsSizes internal constructor(
             val heading: Heading,
             val label: Label
         ) {
-            /** Max widths for Body text contexts. */
+            /**
+             * Max widths for body text contexts.
+             *
+             * @property small Max width constraint for small body text.
+             * @property medium Max width constraint for medium body text.
+             * @property large Max width constraint for large body text.
+             */
             @ConsistentCopyVisibility
             data class Body internal constructor(
                 val small: Dp,
                 val medium: Dp,
                 val large: Dp
             )
 
-            /** Max widths for Display text contexts. */
+            /**
+             * Max widths for display text contexts.
+             *
+             * @property small Max width constraint for small display text.
+             * @property medium Max width constraint for medium display text.
+             * @property large Max width constraint for large display text.
+             */
             @ConsistentCopyVisibility
             data class Display internal constructor(
                 val small: Dp,
                 val medium: Dp,
                 val large: Dp
             )
 
-            /** Max widths for Heading text contexts. */
+            /**
+             * Max widths for heading text contexts.
+             *
+             * @property small Max width constraint for small heading text.
+             * @property medium Max width constraint for medium heading text.
+             * @property large Max width constraint for large heading text.
+             * @property extraLarge Max width constraint for extra large heading text.
+             */
             @ConsistentCopyVisibility
             data class Heading internal constructor(
                 val small: Dp,
@@ -273,7 +362,14 @@ data class OudsSizes internal constructor(
                 val extraLarge: Dp
             )
 
-            /** Max widths for Label text contexts. */
+            /**
+             * Max widths for label text contexts.
+             *
+             * @property small Max width constraint for small label text.
+             * @property medium Max width constraint for medium label text.
+             * @property large Max width constraint for large label text.
+             * @property extraLarge Max width constraint for extra large label text.
+             */
             @ConsistentCopyVisibility
             data class Label internal constructor(
                 val small: Dp,