Fixes in KDocs (#290)

Author: ASmirnov-HORIS

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

@@ -26,18 +26,15 @@ import org.jetbrains.letsPlot.tooltips.TooltipOptions
  * Computed variables:
  *
  * - ..density.. : density estimate (mapped by default).
- * - ..count.. : density * number of points (corresponds to number of nearby points for ``'neighbours'`` method).
+ * - ..count.. : density * number of points (corresponds to number of nearby points for `"neighbours"` method).
  * - ..scaled.. : density estimate, scaled to maximum of 1.
 
  * To hide axis tooltips, set "blank" or the result of `elementBlank()`
  * to the `axisTooltip`, `axisTooltipX` or `axisTooltipY` parameter of the `theme()`.
  *
- * ## Examples
- *
- *
  * @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.pointdensity()`. The statistical transformation to use on the data for this layer.
+ * @param stat default = `Stat.pointDensity()`. 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 Position adjustment: `positionIdentity`, `positionStack()`, `positionDodge()`, etc.
  *  see [Position](https://lets-plot.org/kotlin/-lets--plot--kotlin/org.jetbrains.letsPlot.pos/).
@@ -62,7 +59,8 @@ import org.jetbrains.letsPlot.tooltips.TooltipOptions
  * @param fill Fill color.
  *  For more info see: [aesthetics.html#color-and-fill](https://lets-plot.org/kotlin/aesthetics.html#color-and-fill).
  * @param weight Used by "density" stat to compute weighted density.
- * @param method One of `"auto"`, `"neighbours"`, `"kde2d"` (default = `"auto"`). Method to compute the density estimate:
+ * @param method default = "auto" ("auto", "neighbours", "kde2d").
+ *  Method to compute the density estimate:
  *  - `"neighbours"` - estimates density from the number of nearby points.
  *  - `"kde2d"` - estimates density using a smoothed 2D kernel density.
  *  - `"auto"` - automatically selects an estimation method based on data size.

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

@@ -8,7 +8,27 @@ 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).
+ * ## Data Grouping
+ *
+ * The `group` parameter is not a true aesthetic but controls how data is grouped for visualization:
+ *
+ * **Default Grouping Behavior:**
+ *
+ * Lets-Plot automatically groups data by discrete variables mapped to aesthetics like `color`, `shape`, `linetype`, etc.
+ * This creates separate visual elements (lines, paths, polygons) for each unique combination of these variables.
+ *
+ * **Explicit Group Control:**
+ *
+ * - Use `group = "variableName"` to group only by that specific variable, overriding default grouping
+ *
+ * - Use `group = listOf("var1", "var2", ...)` to group by the interaction of multiple variables
+ *
+ * - Use `group = emptyList()` to disable all the grouping completely
+ *
+ * @property group Data grouping control (not a true aesthetic).
+ *  Use a variable name to group by that variable,
+ *  a list of variables to group by their interaction,
+ *  or an empty list to disable all grouping.
  */
 interface WithGroupOption {
     val group: Any?

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

@@ -15,7 +15,8 @@ import org.jetbrains.letsPlot.intern.OptionsCapsule
  *  or a Double array of length 2. Only used when `method = "kde2d"`.
  * @property kernel The kernel used for KDE. One of `"gaussian"`, `"cosine"`, `"optcosine"`, `"rectangular"`/`"uniform"`,
  *  `"triangular"`, `"biweight"`/`"quartic"`, `"epanechikov"`/`"parabolic"`. Only used when `method = "kde2d"`.
- * @property method One of `"auto"`, `"neighbours"`, `"kde2d"` (default = `"auto"`). Method to compute the density estimate:
+ * @property method default = "auto" ("auto", "neighbours", "kde2d").
+ *  Method to compute the density estimate:
  *  - `"neighbours"` - estimates density from the number of nearby points.
  *  - `"kde2d"` - estimates density using a smoothed 2D kernel density.
  *  - `"auto"` - automatically selects an estimation method based on data size.

plot-api/src/commonMain/kotlin/org/jetbrains/letsPlot/themes/theme.kt

@@ -41,7 +41,7 @@ import org.jetbrains.letsPlot.intern.filterNonNullValues
  *
  * - [superscript_exponent.ipynb](https://nbviewer.org/github/JetBrains/lets-plot-docs/blob/master/source/kotlin_examples/cookbook/superscript_exponent.ipynb)
  *
- * @param exponentFormat default="e" ("e", "pow", "pow_full").
+ * @param exponentFormat default="pow" ("e", "pow", "pow_full").
  *  Controls the appearance of numbers formatted with "e" or "g" types.
  *
  *  Value is either a string - style, or a list: `listOf(style, lower_exp_bound, upper_exp_bound)`
@@ -527,7 +527,7 @@ class theme(
 }
 
 /**
- * Specifies how non-data components of the plot are drawn.
+ * Specify how non-data components of the plot are drawn.
  * This theme element draws nothing, and assigns no space.
  *
  * ## Examples
@@ -538,7 +538,7 @@ fun elementBlank() = mapOf(Option.Theme.Elem.BLANK to true)
 
 
 /**
- * Specifies how non-data components of the plot are drawn.
+ * Specify how non-data components of the plot are drawn.
  * This theme element draws borders and backgrounds.
  *
  * ## Examples
@@ -570,7 +570,7 @@ fun elementRect(
 
 
 /**
- * Specifies how non-data components of the plot are drawn.
+ * Specify how non-data components of the plot are drawn.
  * This theme element draws lines.
  *
  * ## Examples
@@ -599,7 +599,7 @@ fun elementLine(
 
 
 /**
- * Specifies how non-data components of the plot are drawn.
+ * Specify how non-data components of the plot are drawn.
  * This theme element draws text.
  *
  * ## Examples
@@ -657,9 +657,16 @@ fun elementText(
 
 
 /**
- * Specifies how non-data components of the plot are drawn.
+ * Specify how non-data components of the plot are drawn.
  * This theme element draws text with Markdown support.
  *
+ * Supported features:
+ *
+ * - Emphasis (*, **, ***, _, __, ___)
+ * - Coloring with inline style (`<span style='color:red'>text</span>`)
+ * - Links with anchor tags (`<a href="https://lets-plot.org">Lets-Plot</a>`). Supports target attribute (default is `"_blank"`)
+ * - Multiple lines using double space and a newline delimiter (  `\n`)
+ *
  * ## Examples
  *
  * - [markdown.ipynb](https://nbviewer.org/github/JetBrains/lets-plot-docs/blob/master/source/kotlin_examples/cookbook/markdown.ipynb)

plot-api/src/commonMain/kotlin/org/jetbrains/letsPlot/themes/themeFlavors.kt

@@ -12,7 +12,7 @@ import org.jetbrains.letsPlot.intern.OptionsMap
 
 
 /**
- * Darcula color scheme.
+ * Set the Darcula color scheme.
  *
  * ## Examples
  *
@@ -24,7 +24,7 @@ fun flavorDarcula() = OptionsMap(
 )
 
 /**
- * Solarized light color scheme.
+ * Set the Solarized Light color scheme.
  *
  * ## Examples
  *
@@ -36,7 +36,7 @@ fun flavorSolarizedLight() = OptionsMap(
 )
 
 /**
- * Solarized dark color scheme.
+ * Set the Solarized Dark color scheme.
  *
  * ## Examples
  *
@@ -48,7 +48,7 @@ fun flavorSolarizedDark() = OptionsMap(
 )
 
 /**
- * High contrast light color scheme.
+ * Set a high-contrast light color scheme.
  *
  * ## Examples
  *
@@ -60,7 +60,7 @@ fun flavorHighContrastLight() = OptionsMap(
 )
 
 /**
- * High contrast dark color scheme.
+ * Set a high-contrast dark color scheme.
  *
  * ## Examples
  *
@@ -72,7 +72,7 @@ fun flavorHighContrastDark() = OptionsMap(
 )
 
 /**
- * Set the theme’s default color scheme.
+ * Set the theme's default color scheme.
  * Use to override other flavors or to make defaults explicit.
  *
  */

plot-api/src/commonMain/kotlin/org/jetbrains/letsPlot/themes/themeSet.kt

@@ -12,7 +12,7 @@ import org.jetbrains.letsPlot.intern.OptionsMap
 
 
 /**
- * Grey background and white gridlines. The same as themeGray().
+ * Set the grey background and white gridlines. The same as `themeGray()`.
  *
  * ## Examples
  *
@@ -26,7 +26,7 @@ fun themeGrey() = OptionsMap(
 
 
 /**
- * Gray background and white gridlines. The same as themeGrey().
+ * Set the gray background and white gridlines. The same as `themeGrey()`.
  *
  * ## Examples
  *
@@ -40,7 +40,7 @@ fun themeGray() = OptionsMap(
 
 
 /**
- * Grey lines on white background with dark grey plot border.
+ * Set a dark grey plot border and grey gridlines on the white background.
  *
  * ## Examples
  *
@@ -54,7 +54,7 @@ fun themeBW() = OptionsMap(
 
 
 /**
- * Light grey lines of various widths on white background.
+ * Set the light grey lines of various widths on the white background.
  *
  * ## Examples
  *
@@ -68,7 +68,7 @@ fun themeLight() = OptionsMap(
 
 
 /**
- * Dark grey axes and no gridlines.
+ * Set the dark grey axes and no gridlines on the white background.
  *
  * ## Examples
  *
@@ -82,7 +82,7 @@ fun themeClassic() = OptionsMap(
 
 
 /**
- * A minimalistic theme without axes lines.
+ * Set a minimalistic theme without axes lines.
  *
  * ## Examples
  *
@@ -96,7 +96,7 @@ fun themeMinimal() = OptionsMap(
 
 
 /**
- * Default theme similar to `themeMinimal()` but with x-axis line and only major grid lines.
+ * Set the default theme similar to `themeMinimal()` adding an x-axis line and only major gridlines.
  *
  * ## Examples
  *
@@ -110,7 +110,7 @@ fun themeMinimal2() = OptionsMap(
 
 
 /**
- * Basic settings are applied.
+ * Set a basic blue-accented scheme with the light blue background.
  *
  * ## Examples
  *
@@ -124,7 +124,7 @@ fun themeNone() = OptionsMap(
 
 
 /**
- * A completely blank (or "void") background theme: no borders, axes, or gridlines.
+ * Set a completely blank (or "void") background theme by removing all non-data elements: no borders, axes, or gridlines.
  *
  * ## Examples
  *