Copilot: Add comprehensive KDoc documentation to all intern geom layer files with standardized format and proper Kotlin conventions (#285)

Author: Copilot

plot-api/src/commonMain/kotlin/org/jetbrains/letsPlot/intern/layer/geom/ABLineAesthetics.kt

@@ -8,6 +8,22 @@ package org.jetbrains.letsPlot.intern.layer.geom
 import org.jetbrains.letsPlot.intern.Options
 import org.jetbrains.letsPlot.intern.OptionsCapsule
 
+/**
+ * Aesthetic properties supported by [geomABLine()][org.jetbrains.letsPlot.geom.geomABLine].
+ *
+ * @property slope The line slope.
+ * @property intercept The value of y at the point where the line crosses the y-axis.
+ * @property alpha Transparency level of a layer.
+ *  Understands numbers between 0 and 1.
+ * @property color Color of the geometry.
+ *  For more info see: [aesthetics.html#color-and-fill](https://lets-plot.org/kotlin/aesthetics.html#color-and-fill).
+ * @property linetype Type of the line.
+ *  Accept codes or names (0 = "blank", 1 = "solid", 2 = "dashed", 3 = "dotted", 4 = "dotdash", 5 = "longdash", 6 = "twodash"),
+ *  a hex string (up to 8 digits for dash-gap lengths),
+ *  or a pattern `offset to listOf(dash, gap, ...)` / `listOf(dash, gap, ...)`.
+ *  For more info see: [aesthetics.html#line-types](https://lets-plot.org/kotlin/aesthetics.html#line-types).
+ * @property size Line width.
+ */
 interface ABLineAesthetics : OptionsCapsule {
     val slope: Any?
     val intercept: Any?

plot-api/src/commonMain/kotlin/org/jetbrains/letsPlot/intern/layer/geom/ABLineMapping.kt

@@ -7,6 +7,26 @@ package org.jetbrains.letsPlot.intern.layer.geom
 
 import org.jetbrains.letsPlot.intern.layer.WithGroupOption
 
+/**
+ * Aesthetic mappings supported by [geomABLine()][org.jetbrains.letsPlot.geom.geomABLine].
+ *
+ * @param slope The line slope.
+ * @param intercept The value of y at the point where the line crosses the y-axis.
+ * @param alpha Transparency level of a layer.
+ *  Understands numbers between 0 and 1.
+ * @param color Color of the geometry.
+ *  For more info see: [aesthetics.html#color-and-fill](https://lets-plot.org/kotlin/aesthetics.html#color-and-fill).
+ * @param linetype Type of the line.
+ *  Accept codes or names (0 = "blank", 1 = "solid", 2 = "dashed", 3 = "dotted", 4 = "dotdash", 5 = "longdash", 6 = "twodash"),
+ *  a hex string (up to 8 digits for dash-gap lengths),
+ *  or a pattern `offset to listOf(dash, gap, ...)` / `listOf(dash, gap, ...)`.
+ *  For more info see: [aesthetics.html#line-types](https://lets-plot.org/kotlin/aesthetics.html#line-types).
+ * @param size Line width.
+ * @param group Grouping key. If not set, grouping may be inferred from other aesthetics (e.g., color, size).
+ * @param paint_a Auxiliary paint channel A that can be used as either `color` or `fill` as needed. Map a variable here for composite/multi-channel color with a matching scale.
+ * @param paint_b Auxiliary paint channel B. See `paint_a`.
+ * @param paint_c Auxiliary paint channel C. See `paint_a`.
+ */
 class ABLineMapping(
     override var slope: Any? = null,
     override var intercept: Any? = null,

plot-api/src/commonMain/kotlin/org/jetbrains/letsPlot/intern/layer/geom/AreaAesthetics.kt

@@ -8,6 +8,24 @@ package org.jetbrains.letsPlot.intern.layer.geom
 import org.jetbrains.letsPlot.intern.Options
 import org.jetbrains.letsPlot.intern.OptionsCapsule
 
+/**
+ * Aesthetic properties supported by [geomArea()][org.jetbrains.letsPlot.geom.geomArea].
+ *
+ * @property x X-axis coordinates.
+ * @property y Y-axis coordinates.
+ * @property alpha Transparency level of a layer. 
+ *  Understands numbers between 0 and 1.
+ * @property color Color of the geometry.
+ *  For more info see: [aesthetics.html#color-and-fill](https://lets-plot.org/kotlin/aesthetics.html#color-and-fill).
+ * @property fill Fill color.
+ *  For more info see: [aesthetics.html#color-and-fill](https://lets-plot.org/kotlin/aesthetics.html#color-and-fill).
+ * @property linetype Type of the line of border.
+ *  Accept codes or names (0 = "blank", 1 = "solid", 2 = "dashed", 3 = "dotted", 4 = "dotdash", 5 = "longdash", 6 = "twodash"),
+ *  a hex string (up to 8 digits for dash-gap lengths),
+ *  or a pattern `offset to listOf(dash, gap, ...)` / `listOf(dash, gap, ...)`.
+ *  For more info see: [aesthetics.html#line-types](https://lets-plot.org/kotlin/aesthetics.html#line-types).
+ * @property size Line width.
+ */
 interface AreaAesthetics : OptionsCapsule {
     val x: Any?
     val y: Any?

plot-api/src/commonMain/kotlin/org/jetbrains/letsPlot/intern/layer/geom/AreaMapping.kt

@@ -7,6 +7,28 @@ package org.jetbrains.letsPlot.intern.layer.geom
 
 import org.jetbrains.letsPlot.intern.layer.WithGroupOption
 
+/**
+ * Aesthetic mappings supported by [geomArea()][org.jetbrains.letsPlot.geom.geomArea].
+ *
+ * @param x X-axis coordinates.
+ * @param y Y-axis coordinates.
+ * @param alpha Transparency level of a layer. 
+ *  Understands numbers between 0 and 1.
+ * @param color Color of the geometry.
+ *  For more info see: [aesthetics.html#color-and-fill](https://lets-plot.org/kotlin/aesthetics.html#color-and-fill).
+ * @param fill Fill color.
+ *  For more info see: [aesthetics.html#color-and-fill](https://lets-plot.org/kotlin/aesthetics.html#color-and-fill).
+ * @param linetype Type of the line of border.
+ *  Accept codes or names (0 = "blank", 1 = "solid", 2 = "dashed", 3 = "dotted", 4 = "dotdash", 5 = "longdash", 6 = "twodash"),
+ *  a hex string (up to 8 digits for dash-gap lengths),
+ *  or a pattern `offset to listOf(dash, gap, ...)` / `listOf(dash, gap, ...)`.
+ *  For more info see: [aesthetics.html#line-types](https://lets-plot.org/kotlin/aesthetics.html#line-types).
+ * @param size Line width.
+ * @param group Grouping key. If not set, grouping may be inferred from other aesthetics (e.g., color, size).
+ * @param paint_a Auxiliary paint channel A that can be used as either `color` or `fill` as needed. Map a variable here for composite/multi-channel color with a matching scale.
+ * @param paint_b Auxiliary paint channel B. See `paint_a`.
+ * @param paint_c Auxiliary paint channel C. See `paint_a`.
+ */
 class AreaMapping(
     override var x: Any? = null,
     override var y: Any? = null,

plot-api/src/commonMain/kotlin/org/jetbrains/letsPlot/intern/layer/geom/AreaRidgesAesthetics.kt

@@ -8,6 +8,25 @@ package org.jetbrains.letsPlot.intern.layer.geom
 import org.jetbrains.letsPlot.intern.Options
 import org.jetbrains.letsPlot.intern.OptionsCapsule
 
+/**
+ * Aesthetic properties supported by [geomAreaRidges()][org.jetbrains.letsPlot.geom.geomAreaRidges].
+ *
+ * @property x X-axis coordinates.
+ * @property y Y-axis coordinates.
+ * @property height Height of the ridge. Assumed to be between 0 and 1, though this is not required.
+ * @property quantile Quantile values to draw quantile lines and fill quantiles of the geometry by color.
+ * @property alpha Transparency level of a layer. Understands numbers between 0 and 1.
+ * @property color Color of the geometry.
+ *  For more info see: [aesthetics.html#color-and-fill](https://lets-plot.org/kotlin/aesthetics.html#color-and-fill).
+ * @property fill Fill color.
+ *  For more info see: [aesthetics.html#color-and-fill](https://lets-plot.org/kotlin/aesthetics.html#color-and-fill).
+ * @property linetype Type of the line of border.
+ *  Accept codes or names (0 = "blank", 1 = "solid", 2 = "dashed", 3 = "dotted", 4 = "dotdash", 5 = "longdash", 6 = "twodash"),
+ *  a hex string (up to 8 digits for dash-gap lengths),
+ *  or a pattern `offset to listOf(dash, gap, ...)` / `listOf(dash, gap, ...)`.
+ *  For more info see: [aesthetics.html#line-types](https://lets-plot.org/kotlin/aesthetics.html#line-types).
+ * @property size Defines line width.
+ */
 @Suppress("SpellCheckingInspection")
 interface AreaRidgesAesthetics : OptionsCapsule {
     val x: Any?

plot-api/src/commonMain/kotlin/org/jetbrains/letsPlot/intern/layer/geom/AreaRidgesMapping.kt

@@ -7,6 +7,29 @@ package org.jetbrains.letsPlot.intern.layer.geom
 
 import org.jetbrains.letsPlot.intern.layer.WithGroupOption
 
+/**
+ * Aesthetic mappings supported by [geomAreaRidges()][org.jetbrains.letsPlot.geom.geomAreaRidges].
+ *
+ * @param x X-axis coordinates.
+ * @param y Y-axis coordinates.
+ * @param height Height of the ridge. Assumed to be between 0 and 1, though this is not required.
+ * @param quantile Quantile values to draw quantile lines and fill quantiles of the geometry by color.
+ * @param alpha Transparency level of a layer. Understands numbers between 0 and 1.
+ * @param color Color of the geometry.
+ *  For more info see: [aesthetics.html#color-and-fill](https://lets-plot.org/kotlin/aesthetics.html#color-and-fill).
+ * @param fill Fill color.
+ *  For more info see: [aesthetics.html#color-and-fill](https://lets-plot.org/kotlin/aesthetics.html#color-and-fill).
+ * @param linetype Type of the line of border.
+ *  Accept codes or names (0 = "blank", 1 = "solid", 2 = "dashed", 3 = "dotted", 4 = "dotdash", 5 = "longdash", 6 = "twodash"),
+ *  a hex string (up to 8 digits for dash-gap lengths),
+ *  or a pattern `offset to listOf(dash, gap, ...)` / `listOf(dash, gap, ...)`.
+ *  For more info see: [aesthetics.html#line-types](https://lets-plot.org/kotlin/aesthetics.html#line-types).
+ * @param size Defines line width.
+ * @param group Grouping key. If not set, grouping may be inferred from other aesthetics (e.g., color, size).
+ * @param paint_a Auxiliary paint channel A that can be used as either `color` or `fill` as needed. Map a variable here for composite/multi-channel color with a matching scale.
+ * @param paint_b Auxiliary paint channel B. See `paint_a`.
+ * @param paint_c Auxiliary paint channel C. See `paint_a`.
+ */
 class AreaRidgesMapping(
     override var x: Any? = null,
     override var y: Any? = null,

plot-api/src/commonMain/kotlin/org/jetbrains/letsPlot/intern/layer/geom/AreaRidgesParameters.kt

@@ -9,6 +9,16 @@ import org.jetbrains.letsPlot.core.spec.Option
 import org.jetbrains.letsPlot.intern.Options
 import org.jetbrains.letsPlot.intern.OptionsCapsule
 
+/**
+ * Properties for parameters of [geomAreaRidges()][org.jetbrains.letsPlot.geom.geomAreaRidges].
+ *
+ * @property scale A multiplicative factor applied to height aesthetic.
+ *  If `scale = 1.0`, the heights of a ridges are automatically scaled
+ *  such that the ridge with `height = 1.0` just touches the one above.
+ * @property minHeight A height cutoff on the drawn ridges.
+ *  All values that fall below this cutoff will be removed.
+ * @property quantileLines Shows the quantile lines.
+ */
 interface AreaRidgesParameters : OptionsCapsule {
     val scale: Number?
     val minHeight: Number?

plot-api/src/commonMain/kotlin/org/jetbrains/letsPlot/intern/layer/geom/BandAesthetics.kt

@@ -3,6 +3,26 @@ package org.jetbrains.letsPlot.intern.layer.geom
 import org.jetbrains.letsPlot.intern.Options
 import org.jetbrains.letsPlot.intern.OptionsCapsule
 
+/**
+ * Aesthetic properties supported by [geomBand()][org.jetbrains.letsPlot.geom.geomBand].
+ *
+ * @property xmin Lower bound for the vertical band.
+ * @property xmax Upper bound for the vertical band.
+ * @property ymin Lower bound for the horizontal band.
+ * @property ymax Upper bound for the horizontal band.
+ * @property alpha Transparency level of a layer.
+ *  Understands numbers between 0 and 1.
+ * @property color Color of the band border.
+ *  For more info see: [aesthetics.html#color-and-fill](https://lets-plot.org/kotlin/aesthetics.html#color-and-fill).
+ * @property fill Fill color.
+ *  For more info see: [aesthetics.html#color-and-fill](https://lets-plot.org/kotlin/aesthetics.html#color-and-fill).
+ * @property size Defines band border width.
+ * @property linetype Type of the line.
+ *  Accept codes or names (0 = "blank", 1 = "solid", 2 = "dashed", 3 = "dotted", 4 = "dotdash", 5 = "longdash", 6 = "twodash"),
+ *  a hex string (up to 8 digits for dash-gap lengths),
+ *  or a pattern `offset to listOf(dash, gap, ...)` / `listOf(dash, gap, ...)`.
+ *  For more info see: [aesthetics.html#line-types](https://lets-plot.org/kotlin/aesthetics.html#line-types).
+ */
 interface BandAesthetics : OptionsCapsule {
     val xmin: Any?
     val xmax: Any?

plot-api/src/commonMain/kotlin/org/jetbrains/letsPlot/intern/layer/geom/BandMapping.kt

@@ -2,6 +2,30 @@ package org.jetbrains.letsPlot.intern.layer.geom
 
 import org.jetbrains.letsPlot.intern.layer.WithGroupOption
 
+/**
+ * Aesthetic mappings supported by [geomBand()][org.jetbrains.letsPlot.geom.geomBand].
+ *
+ * @param xmin Lower bound for the vertical band.
+ * @param xmax Upper bound for the vertical band.
+ * @param ymin Lower bound for the horizontal band.
+ * @param ymax Upper bound for the horizontal band.
+ * @param alpha Transparency level of a layer.
+ *  Understands numbers between 0 and 1.
+ * @param color Color of the band border.
+ *  For more info see: [aesthetics.html#color-and-fill](https://lets-plot.org/kotlin/aesthetics.html#color-and-fill).
+ * @param fill Fill color.
+ *  For more info see: [aesthetics.html#color-and-fill](https://lets-plot.org/kotlin/aesthetics.html#color-and-fill).
+ * @param size Defines band border width.
+ * @param linetype Type of the line.
+ *  Accept codes or names (0 = "blank", 1 = "solid", 2 = "dashed", 3 = "dotted", 4 = "dotdash", 5 = "longdash", 6 = "twodash"),
+ *  a hex string (up to 8 digits for dash-gap lengths),
+ *  or a pattern `offset to listOf(dash, gap, ...)` / `listOf(dash, gap, ...)`.
+ *  For more info see: [aesthetics.html#line-types](https://lets-plot.org/kotlin/aesthetics.html#line-types).
+ * @param group Grouping key. If not set, grouping may be inferred from other aesthetics (e.g., color, size).
+ * @param paint_a Auxiliary paint channel A that can be used as either `color` or `fill` as needed. Map a variable here for composite/multi-channel color with a matching scale.
+ * @param paint_b Auxiliary paint channel B. See `paint_a`.
+ * @param paint_c Auxiliary paint channel C. See `paint_a`.
+ */
 class BandMapping(
     override var xmin: Any? = null,
     override var xmax: Any? = null,

plot-api/src/commonMain/kotlin/org/jetbrains/letsPlot/intern/layer/geom/BarAesthetics.kt

@@ -8,6 +8,20 @@ package org.jetbrains.letsPlot.intern.layer.geom
 import org.jetbrains.letsPlot.intern.Options
 import org.jetbrains.letsPlot.intern.OptionsCapsule
 
+/**
+ * Aesthetic properties supported by [geomBar()][org.jetbrains.letsPlot.geom.geomBar].
+ *
+ * @property x X-axis value (this value will produce cases or bins for bars).
+ * @property y Y-axis value (this value will be used to multiply the case's or bin's counts).
+ * @property alpha Transparency level of a layer.
+ *  Understands numbers between 0 and 1.
+ * @property color Color of the geometry.
+ *  For more info see: [aesthetics.html#color-and-fill](https://lets-plot.org/kotlin/aesthetics.html#color-and-fill).
+ * @property fill Fill color.
+ *  For more info see: [aesthetics.html#color-and-fill](https://lets-plot.org/kotlin/aesthetics.html#color-and-fill).
+ * @property width Width of a bar.
+ * @property size Defines bar line width.
+ */
 interface BarAesthetics : OptionsCapsule {
     val x: Any?
     val y: Any?