Review: Fix kdoc of isOudsInDarkTheme method

paulinea · florentmaitre · commit 70db7a2d1eec · 2025-12-15T16:50:27.000+01:00
diff --git a/core/src/main/java/com/orange/ouds/core/theme/OudsTheme.kt b/core/src/main/java/com/orange/ouds/core/theme/OudsTheme.kt
@@ -220,7 +220,7 @@ fun OudsThemeTweak(tweak: OudsTheme.Tweak, content: @Composable () -> Unit) {
  * The OUDS theme can be inverted or forced to light/dark modes using [OudsThemeTweak].
  * The value returned by this function reflects these effective changes.
  *
- * If [OudsThemeTweak] is not used in the layout hierarchy, this function returns the same value as [isSystemInDarkTheme].
+ * If [OudsThemeTweak] is not used in the layout hierarchy, this function returns the value of the `darkThemeEnabled` parameter of the root `OudsTheme` method.
  *
  * @return `true` if the effective OUDS theme is dark, `false` otherwise.
  */

Original file line number	Diff line number	Diff line change
`@@ -220,7 +220,7 @@ fun OudsThemeTweak(tweak: OudsTheme.Tweak, content: @Composable () -> Unit) {`
`220`	`220`	`* The OUDS theme can be inverted or forced to light/dark modes using [OudsThemeTweak].`
`221`	`221`	`* The value returned by this function reflects these effective changes.`
`222`	`222`	`*`
`223`		`- * If [OudsThemeTweak] is not used in the layout hierarchy, this function returns the same value as [isSystemInDarkTheme].`
	`223`	+ * If [OudsThemeTweak] is not used in the layout hierarchy, this function returns the value of the `darkThemeEnabled` parameter of the root `OudsTheme` method.
`224`	`224`	`*`
`225`	`225`	* @return `true` if the effective OUDS theme is dark, `false` otherwise.
`226`	`226`	`*/`