From 7448224aadd3e5780848ec5753bb725bd03efcff Mon Sep 17 00:00:00 2001
From: Patrick Michalik <120058021+patrickmichalik@users.noreply.github.com>
Date: Tue, 9 Apr 2024 19:49:13 +0200
Subject: [PATCH] Add `CandlestickCartesianLayerModel.Entry` documentation

---
 .../cartesian/model/CandlestickCartesianLayerModel.kt | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)

diff --git a/vico/core/src/main/java/com/patrykandpatrick/vico/core/cartesian/model/CandlestickCartesianLayerModel.kt b/vico/core/src/main/java/com/patrykandpatrick/vico/core/cartesian/model/CandlestickCartesianLayerModel.kt
index 69792529c..778332338 100644
--- a/vico/core/src/main/java/com/patrykandpatrick/vico/core/cartesian/model/CandlestickCartesianLayerModel.kt
+++ b/vico/core/src/main/java/com/patrykandpatrick/vico/core/cartesian/model/CandlestickCartesianLayerModel.kt
@@ -97,7 +97,16 @@ public class CandlestickCartesianLayerModel : CartesianLayerModel {
     }
 
     /**
-     * TODO
+     * Houses a single candle’s data.
+     *
+     * @property x the _x_ value.
+     * @property opening the opening price.
+     * @property closing the closing price.
+     * @property low the low price.
+     * @property high the high price.
+     * @property absoluteChange represents the absolute price change ([closing] vs. [opening]).
+     * @property relativeChange represents the relative price change (this [Entry]’s [closing] vs. the previous
+     * [Entry]’s [closing]).
      */
     public open class Entry internal constructor(
         override val x: Float,