From 2e0aab64b18975aa21795da311b6909dcbe9339a Mon Sep 17 00:00:00 2001 From: Boris Zbarsky Date: Fri, 26 May 2023 17:27:42 -0400 Subject: [PATCH] Improve documentation for the "value" of an MTREventReport. (#26856) --- src/darwin/Framework/CHIP/MTRBaseDevice.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/darwin/Framework/CHIP/MTRBaseDevice.h b/src/darwin/Framework/CHIP/MTRBaseDevice.h index 56edeff07f2af3..65e1d9d0cabfbf 100644 --- a/src/darwin/Framework/CHIP/MTRBaseDevice.h +++ b/src/darwin/Framework/CHIP/MTRBaseDevice.h @@ -673,8 +673,10 @@ typedef NS_ENUM(NSUInteger, MTREventPriority) { NSDate * timestampDate API_AVAILABLE(ios(16.5), macos(13.4), watchos(9.5), tvos(16.5)); /** - * An instance of one of the event payload interfaces, or nil if error is not - * nil (in which case there is no payload available). + * An instance of the event payload interface that corresponds to the report's + * path (e.g. MTRBasicInformationClusterStartUpEvent if the path's cluster + * 0x0028 "Basic Information" and the path's event is 0x00 "StartUp"), or nil if + * error is not nil (in which case there is no payload available). */ @property (nonatomic, readonly, copy, nullable) id value;