Skip to content

Commit cbda51a

Browse files
Dokka: Fix KDocs for the ggsave() (indents in the lists).
1 parent 6d41c58 commit cbda51a

File tree

1 file changed

+20
-14
lines changed
  • plot-api/src/jvmMain/kotlin/org/jetbrains/letsPlot/export

1 file changed

+20
-14
lines changed

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

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -34,33 +34,39 @@ private const val DEF_EXPORT_DIR = "lets-plot-images"
3434
*
3535
* - If `w`, `h`, `unit`, and `dpi` are all specified:
3636
*
37-
* - The plot's pixel size (default or set via [ggsize()][org.jetbrains.letsPlot.ggsize]) is ignored.
38-
* - The output size is computed from the given dimensions and DPI.
39-
* - The plot is resized to fit the specified `w` x `h` area, which may affect the layout.
37+
* - The plot's pixel size (default or set via [ggsize()][org.jetbrains.letsPlot.ggsize]) is ignored.
38+
* - The output size is computed from the given dimensions and DPI.
39+
*
40+
* - The plot is resized to fit the specified `w` x `h` area, which may affect the layout.
4041
*
4142
* - If only `dpi` is specified:
42-
* - 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.
43-
* - The output size is computed from this size and `dpi`.
44-
* - The plot maintains its aspect ratio, preserving layout, tick labels, and other visual elements.
45-
* - Useful for printing - the plot will appear nearly the same size as on screen.
43+
*
44+
* - 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.
45+
* - The output size is computed from this size and `dpi`.
46+
*
47+
* - The plot maintains its aspect ratio, preserving layout, tick labels, and other visual elements.
48+
* - Useful for printing - the plot will appear nearly the same size as on screen.
4649
*
4750
* - If `w` and `h` are not specified:
48-
* - The `scale` parameter is used to determine the output size.
4951
*
50-
* - The plot maintains its aspect ratio, preserving layout, tick labels, and other visual elements.
51-
* - Useful for generating high-resolution images suitable for publication.
52+
* - The `scale` parameter is used to determine the output size.
53+
*
54+
* - The plot maintains its aspect ratio, preserving layout, tick labels, and other visual elements.
55+
* - Useful for generating high-resolution images suitable for publication.
5256
*
5357
* **For SVG:**
5458
*
5559
* - If `w`, `h`, and `unit` are specified:
56-
* - The plot's pixel size (default or set via [ggsize()][org.jetbrains.letsPlot.ggsize]) is ignored.
57-
* - The output size is set from the given values.
60+
*
61+
* - The plot's pixel size (default or set via [ggsize()][org.jetbrains.letsPlot.ggsize]) is ignored.
62+
* - The output size is set from the given values.
5863
*
5964
* **For HTML:**
6065
*
6166
* - If `w` and `h` are specified:
62-
* - The plot's pixel size (default or set via [ggsize()][org.jetbrains.letsPlot.ggsize]) is ignored.
63-
* - The output size is determined directly from the specified `w` and `h`, which are treated as pixel values.
67+
*
68+
* - The plot's pixel size (default or set via [ggsize()][org.jetbrains.letsPlot.ggsize]) is ignored.
69+
* - The output size is determined directly from the specified `w` and `h`, which are treated as pixel values.
6470
*
6571
* ## Examples
6672
*

0 commit comments

Comments
 (0)