Skip to content

Commit

Permalink
Added header doc changes about nullable expected values and expected …
Browse files Browse the repository at this point in the history
…values interval
  • Loading branch information
jtung-apple committed Oct 24, 2022
1 parent e834221 commit da55472
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion src/darwin/Framework/CHIP/MTRDevice.h
Original file line number Diff line number Diff line change
Expand Up @@ -117,11 +117,13 @@ typedef NS_ENUM(NSUInteger, MTRDeviceState) {
* @param expectedValues array of dictionaries containing the expected values in the same format as
* attribute read completion handler. Requires MTRAttributePathKey values.
* See MTRDeviceResponseHandler definition for dictionary details.
* This argument is ignored if expectedValueInterval is <= 0.
*
* TODO: document better the expectedValues is how this command is expected to change attributes when read, and that the next
* readAttribute will get these values
*
* @param expectedValueInterval maximum interval in milliseconds during which reads of the attribute will return the value being
* written. This value will be clamped to timeout
* written. This value will be clamped to timeout. This argument is ignored if expectedValues is nil.
*
* @param timeout timeout in milliseconds for timed invoke, or nil.
*
Expand Down

0 comments on commit da55472

Please sign in to comment.