Update KDocs for waterfallPlot(), geomSina() and scaleX|YDateTime().

Author: ASmirnov-HORIS

plot-api/src/commonMain/kotlin/org/jetbrains/letsPlot/bistro/waterfall/WaterfallPlot.kt

@@ -87,20 +87,20 @@ package org.jetbrains.letsPlot.bistro.waterfall
  *  Set "blank" or result of `elementBlank()` to draw nothing.
  *  Set `elementLine()` to specify parameters.
  * @param relativeLabels Result of the call to the `layerLabels()` function.
- * Specify content and formatting of annotation labels on relative change bars.
- * If specified, overrides `labelFormat` for relative bars.
- * See `layer_labels() <https://lets-plot.org/kotlin/api-reference/-lets--plot--kotlin/org.jetbrains.letsPlot.annotations/layer-labels/index.html>`__.
+ *  Specify content and formatting of annotation labels on relative change bars.
+ *  If specified, overrides `labelFormat` for relative bars.
+ *  See `layer_labels() <https://lets-plot.org/kotlin/api-reference/-lets--plot--kotlin/org.jetbrains.letsPlot.annotations/layer-labels/index.html>`__.
  * @param absoluteLabels Result of the call to the `layerLabels()` function.
- * Specify content and formatting of annotation labels on absolute value bars.
- * If specified, overrides `labelFormat` for absolute bars.
- * See `layer_labels() <https://lets-plot.org/kotlin/api-reference/-lets--plot--kotlin/org.jetbrains.letsPlot.annotations/layer-labels/index.html>`__.
+ *  Specify content and formatting of annotation labels on absolute value bars.
+ *  If specified, overrides `labelFormat` for absolute bars.
+ *  See `layer_labels() <https://lets-plot.org/kotlin/api-reference/-lets--plot--kotlin/org.jetbrains.letsPlot.annotations/layer-labels/index.html>`__.
  * @param label Label on the bar.
- * Style configuration for labels on bars. Applied to default labels or to
- * relative/absolute labels when `relativeLabels` or `absoluteLabels` are specified.
- * Set "blank" or result of `elementBlank()` to draw nothing.
- * Set `elementText()` to specify style parameters.
- * Use `elementText(color="inherit")` to make labels inherit the color of bar borders.
- * See `elementText() <https://lets-plot.org/kotlin/api-reference/-lets--plot--kotlin/org.jetbrains.letsPlot.themes/element-text.html>`__.
+ *  Style configuration for labels on bars. Applied to default labels or to
+ *  relative/absolute labels when `relativeLabels` or `absoluteLabels` are specified.
+ *  Set "blank" or result of `elementBlank()` to draw nothing.
+ *  Set `elementText()` to specify style parameters.
+ *  Use `elementText(color="inherit")` to make labels inherit the color of bar borders.
+ *  See `elementText() <https://lets-plot.org/kotlin/api-reference/-lets--plot--kotlin/org.jetbrains.letsPlot.themes/element-text.html>`__.
  * @param labelFormat Format used to transform label mapping values to a string.
  *  For more info see: [formats.html](https://lets-plot.org/kotlin/formats.html)
  *  Note: the "$" must be escaped as "\$".
@@ -109,8 +109,8 @@ package org.jetbrains.letsPlot.bistro.waterfall
  *  - ".2f" -> "12.45"
  *  - "Score: {.2f}" -> "Score: 12.45"
  *  - "Score: {}" -> "Score: 12.454789"
- * @param backgroundLayers will be added behind the waterfall
- * Background layers to be added to the plot, a single Layer or FeatureList.
+ * @param backgroundLayers Will be added behind the waterfall.
+ *  Background layers to be added to the plot, a single layer or feature list.
  */
 fun waterfallPlot(
     data: Map<*, *>,

plot-api/src/commonMain/kotlin/org/jetbrains/letsPlot/geom/geom_sina.kt

@@ -17,9 +17,94 @@ import org.jetbrains.letsPlot.intern.layer.stat.SinaStatParameters
 import org.jetbrains.letsPlot.pos.positionDodge
 import org.jetbrains.letsPlot.tooltips.TooltipOptions
 
-/*
-TODO
-*/
+@Suppress("ClassName")
+/**
+ * A sina plot visualizes a single variable across classes, with jitter width reflecting the data density in each class.
+ *
+ * ## Notes
+ *
+ * Computed variables:
+ *
+ * - ..violinwidth.. : density scaled for the sina plot, according to area, counts or to a constant maximum width (mapped by default).
+ * - ..density.. : density estimate.
+ * - ..count.. : density * number of points.
+ * - ..scaled.. : density estimate, scaled to maximum of 1.
+ * - ..quantile.. : quantile estimate.
+ *
+ * To hide axis tooltips, set "blank" or the result of `elementBlank()`
+ * to the `axisTooltip`, `axisTooltipX` or `axisTooltipY` parameter of the `theme()`.
+ *
+ * ## Examples
+ *
+ * - [geom_sina.ipynb](https://nbviewer.org/github/JetBrains/lets-plot-docs/blob/master/source/kotlin_examples/cookbook/geom_sina.ipynb)
+ *
+ * @param data The data to be displayed in this layer. If null, the default, the data
+ *  is inherited from the plot data as specified in the call to [letsPlot][org.jetbrains.letsPlot.letsPlot].
+ * @param stat default = `Stat.sina()`. The statistical transformation to use on the data for this layer.
+ *  Supported transformations: `Stat.identity`, `Stat.bin()`, `Stat.count()`, etc. see [Stat][org.jetbrains.letsPlot.Stat].
+ * @param position default = `positionDodge()`. Position adjustment: `positionIdentity`, `positionStack()`, `positionDodge()`, etc. see
+ *  [Position](https://lets-plot.org/kotlin/-lets--plot--kotlin/org.jetbrains.letsPlot.pos/).
+ * @param showLegend default = true.
+ *  false - do not show legend for this layer.
+ * @param inheritAes default = true.
+ *  false - do not combine the layer aesthetic mappings with the plot shared mappings.
+ * @param manualKey String or result of the call to the `layerKey()` function.
+ *  The key to show in the manual legend. Specifies the text for the legend label or advanced settings using the `layerKey()` function.
+ * @param sampling Result of the call to the `samplingXxx()` function.
+ *  To prevent any sampling for this layer pass value `samplingNone`.
+ *  For more info see [sampling.html](https://lets-plot.org/kotlin/sampling.html).
+ * @param tooltips Result of the call to the `layerTooltips()` function.
+ *  Specifies appearance, style and content.
+ *  Set `tooltips = tooltipsNone` to hide tooltips from the layer.
+ * @param orientation Specifies the axis that the layer's stat and geom should run along.
+ *  The default value (`null`) automatically determines the orientation based on the aesthetic mapping.
+ *  If the automatic detection doesn't work, it can be set explicitly by specifying the "x" or "y" orientation.
+ * @param x X-axis coordinates.
+ * @param y Y-axis coordinates.
+ * @param violinWidth Density scaled for the sina plot, according to area, counts or to a constant maximum width.
+ * @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 shape Shape of the sina points.
+ *  For more info see: [aesthetics.html#point-shapes](https://lets-plot.org/kotlin/aesthetics.html#point-shapes).
+ * @param size Lines width.
+ *  Defines line width.
+ * @param stroke Width of the shape border. Applied only to the shapes having border.
+ * @param width Width of sina bounding box.
+ * @param weight Used by `Stat.sina()` stat to compute weighted density.
+ * @param seed A random seed to make the jitter reproducible.
+ *  If null (the default value), the seed is initialised with a random value.
+ * @param showHalf default = 0.
+ *  - If -1, only half of each group is drawn.
+ *  - If 1, another half is drawn.
+ *  - If 0, sina look as usual.
+ * @param quantiles Draw horizontal lines at the given quantiles of the density estimate.
+ * @param scale default = "area".
+ *  - If "area", all groups have the same area.
+ *  - If "count", areas are scaled proportionally to the number of observations.
+ *  - If "width", all groups have the same maximum width.
+ * @param trim default = true.
+ *  Trim the tails of the violins, which limit the area for sina points, to the range of the data.
+ * @param tailsCutoff default = 3.0.
+ *  Extend domain of each violin, which limit the area for sina points, on `tailsCutoff * bw` if `trim = false`.
+ * @param kernel The kernel we use to calculate the density function. Choose among "gaussian", "cosine", "optcosine",
+ *  "rectangular" (or "uniform"), "triangular", "biweight" (or "quartic"), "epanechikov" (or "parabolic").
+ * @param bw String or Double.
+ *  The method (or exact value) of bandwidth. Either a string (choose among "nrd0" and "nrd") or a double.
+ * @param adjust Adjusts the value of bandwidth by multiplying it. Changes how smooth the frequency curve is.
+ * @param n The number of sampled points for plotting the function.
+ * @param fullScanMax Maximum size of data to use density computation with "full scan".
+ *  For bigger data, less accurate but more efficient density computation is applied.
+ * @param colorBy default = "color" ("fill", "color", "paint_a", "paint_b", "paint_c").
+ *  Defines the color aesthetic for the geometry.
+ * @param fillBy default = "fill" ("fill", "color", "paint_a", "paint_b", "paint_c").
+ *  Defines the fill aesthetic for the geometry.
+ * @param mapping Set of aesthetic mappings.
+ *  Aesthetic mappings describe the way that variables in the data are
+ *  mapped to plot "aesthetics".
+ */
 class geomSina(
     data: Map<*, *>? = null,
     stat: StatOptions = Stat.sina(),

plot-api/src/commonMain/kotlin/org/jetbrains/letsPlot/scale/DateTime.kt

@@ -13,7 +13,11 @@ import org.jetbrains.letsPlot.intern.Scale
 import org.jetbrains.letsPlot.intern.checkScaleExpand
 
 /**
- * Position scale x for date/time data.
+ * Position scale for the x-axis with date/time data.
+ * The input is expected to be either a series of integers representing milliseconds since the Unix epoch,
+ * or kotlinx.datetime, or java.util datetime objects.
+ * Assumes UTC timezone if no timezone information is present in the data (naive datetime).
+ * For timezone-aware datetime objects, the timezone information from the data is preserved.
  *
  * ## Examples
  *
@@ -79,7 +83,11 @@ fun scaleXDateTime(
 }
 
 /**
- * Position scale y for date/time data.
+ * Position scale for the y-axis with date/time data.
+ * The input is expected to be either a series of integers representing milliseconds since the Unix epoch,
+ * or kotlinx.datetime, or java.util datetime objects.
+ * Assumes UTC timezone if no timezone information is present in the data (naive datetime).
+ * For timezone-aware datetime objects, the timezone information from the data is preserved.
  *
  * ## Examples
  *