Skip to content

Commit ceabb63

Browse files
committed
Add documentation on tokens files
1 parent e3720e3 commit ceabb63

File tree

10 files changed

+650
-10
lines changed

10 files changed

+650
-10
lines changed

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

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,33 @@ import com.orange.ouds.theme.tokens.semantic.OudsBorderSemanticTokens
4040
import java.util.Locale
4141

4242
/**
43-
* @suppress
43+
* Holds all the border-related properties defined in the OUDS theme.
44+
*
45+
* Borders are used to define boundaries around UI elements to materialise the visual hierarchy and improve usability.
46+
*
47+
* > Design guidelines: [Border tokens documentation](https://unified-design-system.orange.com/472794e18/p/76909d-border)
48+
*
49+
* @property width Collection of border width values.
50+
* @property radius Collection of border radius values.
51+
* @property style Collection of border styles (solid, dashed, etc.).
4452
*/
4553
data class OudsBorders(
4654
val width: Width,
4755
val radius: Radius,
4856
val style: Style
4957
) {
58+
/**
59+
* Represents the available border widths in OUDS.
60+
*
61+
* @property none Width of 0 dp, used when no border is visible.
62+
* @property default The standard border width used for most cases.
63+
* @property thin A thinner border width for subtle separations.
64+
* @property medium A medium border width for increased visibility.
65+
* @property thick A thick border width for emphasis.
66+
* @property thicker A very thick border width for strong emphasis.
67+
* @property focus The border width used to indicate focus states.
68+
* @property focusInset The width of the inner border (inset) used in focus states to create a double-border effect.
69+
*/
5070
data class Width(
5171
val none: Dp,
5272
val default: Dp,
@@ -58,6 +78,16 @@ data class OudsBorders(
5878
val focusInset: Dp
5979
)
6080

81+
/**
82+
* Represents the available border radius in OUDS.
83+
*
84+
* @property none No radius (0 dp), resulting in square corners.
85+
* @property default The standard radius used for most components.
86+
* @property small A small radius for subtle rounding.
87+
* @property medium A medium radius for noticeable rounding.
88+
* @property large A large radius for significantly rounded corners.
89+
* @property pill A fully rounded radius.
90+
*/
6191
data class Radius(
6292
val none: Dp,
6393
val default: Dp,
@@ -67,6 +97,12 @@ data class OudsBorders(
6797
val pill: Dp
6898
)
6999

100+
/**
101+
* Represents the available border styles in OUDS.
102+
*
103+
* @property default The standard border style (usually solid).
104+
* @property drag The specific border style used when an element is being dragged (often dashed).
105+
*/
70106
data class Style(
71107
val default: OudsBorderStyle,
72108
val drag: OudsBorderStyle

0 commit comments

Comments
 (0)