Add comprehensive KDoc documentation to plot-api intern layer package files (#287)

Author: Copilot

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

@@ -8,7 +8,10 @@ package org.jetbrains.letsPlot.intern.layer
 import org.jetbrains.letsPlot.intern.GeomKind
 import org.jetbrains.letsPlot.intern.Options
 
-
+/**
+ * @param kind The geometry kind.
+ * @param mapping Set of aesthetic mappings.
+ */
 open class GeomOptions(
     val kind: GeomKind,
     val mapping: Options = Options.empty()

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

@@ -8,6 +8,10 @@ package org.jetbrains.letsPlot.intern.layer
 import org.jetbrains.letsPlot.intern.Layer
 import org.jetbrains.letsPlot.intern.Options
 
+/**
+ * @param geomLayer The geometry layer used in the marginal layer.
+ * @param marginalMapping Additional aesthetic mappings for marginal plots.
+ */
 internal class MarginalLayer(
     geomLayer: Layer,
     marginalMapping: Options,

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

@@ -8,7 +8,10 @@ package org.jetbrains.letsPlot.intern.layer
 import org.jetbrains.letsPlot.intern.Options
 import org.jetbrains.letsPlot.intern.PosKind
 
-
+/**
+ * @param kind The position adjustment kind.
+ * @param parameters Options for position adjustment parameters.
+ */
 class PosOptions(
     val kind: PosKind,
     val parameters: Options = Options.empty()

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

@@ -9,6 +9,11 @@ import org.jetbrains.letsPlot.intern.Options
 import org.jetbrains.letsPlot.intern.SamplingKind
 import org.jetbrains.letsPlot.intern.filterNonNullValues
 
+/**
+ * @property kind The sampling method kind.
+ * @property isNone Whether the sampling is none (no sampling applied).
+ * @property mapping The sampling options mapping.
+ */
 class SamplingOptions internal constructor(
     val kind: SamplingKind,
     private val options: Map<String, Any>

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

@@ -8,6 +8,10 @@ package org.jetbrains.letsPlot.intern.layer
 import org.jetbrains.letsPlot.intern.Options
 import org.jetbrains.letsPlot.intern.StatKind
 
+/**
+ * @param kind The statistic transformation kind.
+ * @param mapping Set of aesthetic mappings.
+ */
 open class StatOptions(
     val kind: StatKind,
     val mapping: Options = Options.empty()

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

@@ -9,6 +9,10 @@ import org.jetbrains.letsPlot.core.spec.Option
 import org.jetbrains.letsPlot.intern.Options
 import org.jetbrains.letsPlot.intern.OptionsCapsule
 
+/**
+ * @property colorBy default = "color" ("fill", "color", "paint_a", "paint_b", "paint_c").
+ *  Defines the color aesthetic for the layer.
+ */
 interface WithColorOption : OptionsCapsule {
     val colorBy: String?
 
@@ -17,6 +21,10 @@ interface WithColorOption : OptionsCapsule {
     )
 }
 
+/**
+ * @property fillBy default = "fill" ("fill", "color", "paint_a", "paint_b", "paint_c").
+ *  Defines the fill aesthetic for the layer.
+ */
 interface WithFillOption : OptionsCapsule {
     val fillBy: String?
 

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

@@ -7,6 +7,9 @@ package org.jetbrains.letsPlot.intern.layer
 
 import org.jetbrains.letsPlot.intern.Options
 
+/**
+ * @property group Grouping key. If not set, grouping may be inferred from other aesthetics (e.g., color, size).
+ */
 interface WithGroupOption {
     val group: Any?
 

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

@@ -4,6 +4,9 @@ import org.jetbrains.letsPlot.core.spec.Option.Geom.Tile
 import org.jetbrains.letsPlot.intern.Options
 import org.jetbrains.letsPlot.intern.OptionsCapsule
 
+/**
+ * @property heightUnit Unit for height values.
+ */
 interface WithHeightUnitOption : OptionsCapsule {
     val heightUnit: String?
 

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

@@ -9,6 +9,13 @@ import org.jetbrains.letsPlot.core.spec.Option.Geom.Point
 import org.jetbrains.letsPlot.intern.Options
 import org.jetbrains.letsPlot.intern.OptionsCapsule
 
+/**
+ * @property sizeUnit Relate the size to the length of the unit step along one of the axes.
+ *  "x" uses the unit step along the x-axis, "y" uses the unit step along the y-axis.
+ *  "min" uses the smaller of the unit steps along the x- and y-axes.
+ *  "max" uses the larger of the unit steps along the x- and y-axes.
+ *  If not specified, no fitting is performed.
+ */
 interface WithSizeUnitOption : OptionsCapsule {
     val sizeUnit: String?
 

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

@@ -7,6 +7,19 @@ package org.jetbrains.letsPlot.intern.layer
 
 import org.jetbrains.letsPlot.spatial.SpatialDataset
 
+/**
+ * @property map Data-structure containing series of planar shapes and, optionally, associates data series (for example:
+ *  names of States and their boundaries).
+ *  All coordinates should be encoded as decimal degrees in WGS84 coordinate reference system.
+ *  Can be used with parameter `mapJoin` for joining data and map coordinates.
+ * @property mapJoin Pair of Names or Pair of Lists of Names.
+ *  Specifies column names to join the `data` and the `map` coordinates on.
+ *  - Pair.first: column name or list of column names in the `data` dataframe.
+ *  - Pair.second: column name or list of column names in the `map` dataframe.
+ * @property useCRS By default, all coordinates are converted into degrees of longitude and latitude,
+ *  and these map coordinates are projected onto the screen coordinates using Mercator projection.
+ *  Specify useCRS = "provided" to keep the SpatialDataset's original coordinate reference system (CRS).
+ */
 interface WithSpatialParameters {
     val map: SpatialDataset?
     val mapJoin: Pair<Any, Any>?