Add KDoc comments for Skip and Span
Add KDoc comments for the Skip and Span class
Test: N/A
Fixed: 273951887
Change-Id: Ib0bbafabc551d429a2368090b1eb7f4bebb0b6d1
diff --git a/constraintlayout/constraintlayout-compose/src/androidMain/kotlin/androidx/constraintlayout/compose/ConstraintLayoutBaseScope.kt b/constraintlayout/constraintlayout-compose/src/androidMain/kotlin/androidx/constraintlayout/compose/ConstraintLayoutBaseScope.kt
index dc5a978..6351bcc 100644
--- a/constraintlayout/constraintlayout-compose/src/androidMain/kotlin/androidx/constraintlayout/compose/ConstraintLayoutBaseScope.kt
+++ b/constraintlayout/constraintlayout-compose/src/androidMain/kotlin/androidx/constraintlayout/compose/ConstraintLayoutBaseScope.kt
@@ -1949,12 +1949,31 @@
}
}
+/**
+ * Defines how many rows and/or columns to skip, starting from the given position.
+ * For Grid, specify the Skip with Skip(position, rows, columns)
+ * For Row/Column, specify the Skip with Skip(position, size)
+ *
+ * @constructor create a new Skip containing the position and size information of the skipped area
+ * @param description string to specify span. For Grid: "position:rowsxcolumns";
+ * For Row/Columns: "position:size"
+ */
@JvmInline
value class Skip(val description: String) {
constructor(position: Int, rows: Int, columns: Int) : this("$position:${rows}x$columns")
constructor(position: Int, size: Int) : this("$position:$size")
}
+/**
+ * Defines the spanned area (that crosses multiple columns and/or rows) that a widget will take
+ * when placed at the given position.
+ * For Grid, specify the Span with Span(position, rows, columns)
+ * For Row/Column, specify the Span with Span(position, size)
+ *
+ * @constructor create a new Span containing the position and size information of the spanned area
+ * @param description string to specify skip. For Grid: "position:rowsxcolumns";
+ * For Row/Columns: "position:size"
+ */
@JvmInline
value class Span(val description: String) {
constructor(position: Int, rows: Int, columns: Int) : this("$position:${rows}x$columns")
