Skip to content

Commit 7117070

Browse files
Improve KDoc (horizontal geoms).
1 parent 87cead1 commit 7117070

File tree

4 files changed

+10
-1
lines changed

4 files changed

+10
-1
lines changed

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ import org.jetbrains.letsPlot.tooltips.TooltipOptions
2222
@Suppress("ClassName")
2323
/**
2424
* Displays bars with horizontal median line.
25+
* Represents a vertical interval, defined by `x`, `ymin`, `ymax`,
26+
* or a horizontal interval, defined by `y`, `xmin`, `xmax`.
27+
* The mean is represented by horizontal (vertical) line.
2528
*
2629
* ## Examples
2730
*

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ import org.jetbrains.letsPlot.tooltips.TooltipOptions
2020
@Suppress("ClassName", "SpellCheckingInspection")
2121
/**
2222
* Displays a line range defined by an upper and lower value.
23+
* Represents a vertical interval, defined by `x`, `ymin`, `ymax`,
24+
* or a horizontal interval, defined by `y`, `xmin`, `xmax`.
2325
*
2426
* ## Examples
2527
*

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,9 @@ import org.jetbrains.letsPlot.tooltips.TooltipOptions
2323
@Suppress("ClassName", "SpellCheckingInspection")
2424
/**
2525
* Adds a vertical line defined by upper and lower value with midpoint at y location.
26+
* Represents a vertical interval, defined by `x`, `ymin`, `ymax`,
27+
* or a horizontal interval, defined by `y`, `xmin`, `xmax`.
28+
* The mid-point is defined by `y` or `x`, respectively.
2629
*
2730
* ## Examples
2831
*

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ import org.jetbrains.letsPlot.tooltips.TooltipOptions
2020

2121
@Suppress("ClassName")
2222
/**
23-
* Displays a y interval defined by ymin and ymax.
23+
* Displays a y interval defined by `ymin` and `ymax`.
24+
* Draws a ribbon bounded by `ymin` and `ymax`, or a vertical ribbon, bounded by `xmin`, `xmax`.
2425
*
2526
* ## Examples
2627
*

0 commit comments

Comments
 (0)