Dokka: Fix KDocs for the ggsave().

Author: ASmirnov-HORIS

plot-api/build.gradle.kts

@@ -94,6 +94,7 @@ tasks.withType<org.jetbrains.dokka.gradle.DokkaTask>().configureEach {
     }
 
     dokkaSourceSets.named("commonMain") { displayName.set("Plot API") }
+    dokkaSourceSets.named("jvmMain") { displayName.set("Plot API (JVM)") }
 }
 
 

plot-api/src/jvmMain/kotlin/org/jetbrains/letsPlot/export/ggsave.kt

@@ -23,67 +23,70 @@ private const val DEF_EXPORT_DIR = "lets-plot-images"
  * Supported formats: SVG, HTML, PNG, JPEG and TIFF.
  * Note: in some configurations raster formats might not be supported.
  *
- * If [path] is not specified, the output file will be saved in
+ * If `path` is not specified, the output file will be saved in
  * `${user.dir}/lets-plot-images`.
  *
- * ## Examples
- *
- * - [export_to_file.ipynb](https://nbviewer.org/github/JetBrains/lets-plot-docs/blob/master/source/kotlin_examples/cookbook/export_to_file.ipynb)
- *
- * @param plot Plot to export.
- * @param filename Name of the file. Must include an extension matching
- *      one of the supported formats: `.svg`, `.html`/`.htm`, `.png`, `.jpeg`/`.jpg`, or `.tiff`/`.tif`
- * @param scale Scaling factor (only for raster formats). Default: 2.0
- * @param w Width of the output image in units.
- * @param h Height of the output image in units.
- * @param unit Unit of the output image. One of: `"in"`, `"cm"`, `"mm"`, `"px"`.
- *      Only applicable when exporting to SVG, PNG, JPG, or TIFF. For HTML, the unit is always `"px"` (pixels).
- *      Default:
- *      "px" (pixels) for SVG,
- *      "in" (inches) for the raster formats (PNG, JPG, and TIFF).
- * @param dpi Resolution in dots per inch.
- *      Only applicable when exporting to the raster formats: PNG, JPG, or TIFF.
-  *     The default value depends on the [unit]:
- *         - for `"px"` it is `96` (output image will have the same pixel size as [w] and [h] values)
- *         - for physical units (`"in"`, `"cm"`, `"mm"`) it is `300`.
- * @param path Path to a directory to save image files in.
- *      Default: `${user.dir}/lets-plot-images`
- *
- * @return Absolute pathname of the created file.
- *
- * ### Notes
+ * ## Notes
  *
  * The output format is inferred from the file extension.
  *
  * **For PNG and PDF:**
  *
- * - If [w], [h], [unit], and [dpi] are all specified:
+ * - If `w`, `h`, `unit`, and `dpi` are all specified:
  *
- *   - The plot's pixel size (default or set via [ggsize()](https://lets-plot.org/kotlin/api-reference/-lets--plot--kotlin/org.jetbrains.letsPlot/ggsize.html) is ignored.
+ *   - The plot's pixel size (default or set via [ggsize()][org.jetbrains.letsPlot.ggsize]) is ignored.
  *   - The output size is computed from the given dimensions and DPI.
- *   - The plot is resized to fit the specified [w] x [h] area, which may affect the layout.
+ *   - The plot is resized to fit the specified `w` x `h` area, which may affect the layout.
  *
- * - If only [dpi] is specified:
- *   - The plot's pixel size (default or set via [ggsize()](https://lets-plot.org/kotlin/api-reference/-lets--plot--kotlin/org.jetbrains.letsPlot/ggsize.html)) is converted to inches assuming the standard display PPI of 96 PPI.
- *   - The output size is computed from this size and [dpi].
+ * - If only `dpi` is specified:
+ *   - The plot's pixel size (default or set via [ggsize()][org.jetbrains.letsPlot.ggsize]) is converted to inches assuming the standard display PPI of 96 PPI.
+ *   - The output size is computed from this size and `dpi`.
  *     - The plot maintains its aspect ratio, preserving layout, tick labels, and other visual elements.
  *     - Useful for printing - the plot will appear nearly the same size as on screen.
  *
- * - If [w] and [h] are not specified:
- *   - The [scale] parameter is used to determine the output size.
+ * - If `w` and `h` are not specified:
+ *   - The `scale` parameter is used to determine the output size.
  *
  *   - The plot maintains its aspect ratio, preserving layout, tick labels, and other visual elements.
  *   - Useful for generating high-resolution images suitable for publication.
  *
  * **For SVG:**
- * - If [w], [h], and [unit] are specified:
- *   - The plot's pixel size (default or set via [ggsize()](https://lets-plot.org/kotlin/api-reference/-lets--plot--kotlin/org.jetbrains.letsPlot/ggsize.html)) is ignored.
+ *
+ * - If `w`, `h`, and `unit` are specified:
+ *   - The plot's pixel size (default or set via [ggsize()][org.jetbrains.letsPlot.ggsize]) is ignored.
  *   - The output size is set from the given values.
  *
  * **For HTML:**
- * - If [w] and [h] are specified:
- *   - The plot's pixel size (default or set via [ggsize()](https://lets-plot.org/kotlin/api-reference/-lets--plot--kotlin/org.jetbrains.letsPlot/ggsize.html)) is ignored.
- *   - The output size is determined directly from the specified [w] and [h], which are treated as pixel values.
+ *
+ * - If `w` and `h` are specified:
+ *   - The plot's pixel size (default or set via [ggsize()][org.jetbrains.letsPlot.ggsize]) is ignored.
+ *   - The output size is determined directly from the specified `w` and `h`, which are treated as pixel values.
+ *
+ * ## Examples
+ *
+ * - [export_to_file.ipynb](https://nbviewer.org/github/JetBrains/lets-plot-docs/blob/master/source/kotlin_examples/cookbook/export_to_file.ipynb)
+ *
+ * @param plot Plot to export.
+ * @param filename Name of the file. Must include an extension matching
+ *  one of the supported formats: `.svg`, `.html`/`.htm`, `.png`, `.jpeg`/`.jpg`, or `.tiff`/`.tif`
+ * @param scale Scaling factor (only for raster formats). Default: 2.0
+ * @param w Width of the output image in units.
+ * @param h Height of the output image in units.
+ * @param unit Unit of the output image. One of: `"in"`, `"cm"`, `"mm"`, `"px"`.
+ *  Only applicable when exporting to SVG, PNG, JPG, or TIFF. For HTML, the unit is always `"px"` (pixels).
+ *  Default:
+ *  "px" (pixels) for SVG,
+ *  "in" (inches) for the raster formats (PNG, JPG, and TIFF).
+ * @param dpi Resolution in dots per inch.
+ *  Only applicable when exporting to the raster formats: PNG, JPG, or TIFF.
+ *  The default value depends on the `unit`:
+ *
+ *  - for `"px"` it is `96` (output image will have the same pixel size as `w` and `h` values)
+ *  - for physical units (`"in"`, `"cm"`, `"mm"`) it is `300`.
+ * @param path Path to a directory to save image files in.
+ *  Default: `${user.dir}/lets-plot-images`
+ *
+ * @return Absolute pathname of the created file.
  *
  */
 @Suppress("SpellCheckingInspection")