From b45cff6201374f57c1c19f55922e86f7392a6b21 Mon Sep 17 00:00:00 2001 From: JaffaKetchup Date: Thu, 11 Jan 2024 22:09:55 +0000 Subject: [PATCH] Minor documentation improvements to `LayerHit` --- lib/src/layer/general/hit_detection.dart | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/lib/src/layer/general/hit_detection.dart b/lib/src/layer/general/hit_detection.dart index 686883ce4..5c7536085 100644 --- a/lib/src/layer/general/hit_detection.dart +++ b/lib/src/layer/general/hit_detection.dart @@ -8,9 +8,12 @@ import 'package:meta/meta.dart'; /// Not emitted if the hit was not over a feature. @immutable class LayerHit { - /// `hitValues` from all features hit + /// `hitValue`s from all features hit (which have `hitValue`s defined) /// - /// Ordered in order of the features first-to-last, visually top-to-bottom. + /// If a feature is hit but has no `hitValue` defined, it will not be included. + /// + /// Ordered by their corresponding feature, first-to-last, visually + /// top-to-bottom. final List hitValues; /// Coordinates of the detected hit