Merge "Fix documentation issues in wear-watchface" into androidx-main
diff --git a/wear/watchface/watchface-style/src/main/java/androidx/wear/watchface/style/CurrentUserStyleRepository.kt b/wear/watchface/watchface-style/src/main/java/androidx/wear/watchface/style/CurrentUserStyleRepository.kt
index 4a563e0..2d88c40 100644
--- a/wear/watchface/watchface-style/src/main/java/androidx/wear/watchface/style/CurrentUserStyleRepository.kt
+++ b/wear/watchface/watchface-style/src/main/java/androidx/wear/watchface/style/CurrentUserStyleRepository.kt
@@ -49,12 +49,13 @@
*
* To modify the user style, you should call [toMutableUserStyle] and construct a new [UserStyle]
* instance with [MutableUserStyle.toUserStyle].
- *
+ */
+public class UserStyle
+/**
* @param selectedOptions The [UserStyleSetting.Option] selected for each [UserStyleSetting]
* @param copySelectedOptions Whether to create a copy of the provided [selectedOptions]. If
* `false`, no mutable copy of the [selectedOptions] map should be retained outside this class.
*/
-public class UserStyle
private constructor(
selectedOptions: Map<UserStyleSetting, UserStyleSetting.Option>,
copySelectedOptions: Boolean
@@ -70,6 +71,8 @@
*
* A copy of the [selectedOptions] map will be created, so that changed to the map will not be
* reflected by this object.
+ *
+ * @param selectedOptions The [UserStyleSetting.Option] selected for each [UserStyleSetting]
*/
public constructor(
selectedOptions: Map<UserStyleSetting, UserStyleSetting.Option>
diff --git a/wear/watchface/watchface/src/main/java/androidx/wear/watchface/ComplicationSlot.kt b/wear/watchface/watchface/src/main/java/androidx/wear/watchface/ComplicationSlot.kt
index 5d3c6df..93e468f 100644
--- a/wear/watchface/watchface/src/main/java/androidx/wear/watchface/ComplicationSlot.kt
+++ b/wear/watchface/watchface/src/main/java/androidx/wear/watchface/ComplicationSlot.kt
@@ -131,6 +131,7 @@
* @param boundsType The [ComplicationSlotBoundsTypeIntDef] of the complication
* @param zonedDateTime The [ZonedDateTime] to render the highlight with
* @param color The color to render the highlight with
+ * @param boundingArc Optional [BoundingArc] defining the geometry of an edge complication
*/
@ComplicationExperimental
public fun drawHighlight(
@@ -633,8 +634,12 @@
* @param defaultDataSourcePolicy The [DefaultComplicationDataSourcePolicy] used to select
* the initial complication data source when the watch is first installed.
* @param bounds The complication's [ComplicationSlotBounds]. Its likely the bounding rect
- * will be much larger than the complication and shouldn't directly be used for hit
+ * will have a much larger area than [boundingArc] and shouldn't directly be used for hit
* testing.
+ * @param boundingArc The [BoundingArc] defining the geometry of the edge complication.
+ * @param complicationTapFilter The [ComplicationTapFilter] used to determine whether or not
+ * a tap hit the complication. The default [ComplicationTapFilter] uses [boundingArc] to
+ * perform hit testing.
*/
@JvmStatic
@JvmOverloads
