commit ed2b697f2ca375a7637a9cde0286185518118f53
author Boris Zbarsky <bzbarsky@apple.com> Mon Oct 03 19:06:42 2022 -0400
committer GitHub <noreply@github.com> Mon Oct 03 19:06:42 2022 -0400
tree f1786d08e13e1ff56ace7e53afb21ada3e119611
parent dab3e8f5b000a1b9ca1d889eff8e230437f24032

Document the rendezvousInformation field of SetupPayload better. (#23000)

src/setup_payload/SetupPayload.h

diff --git a/src/setup_payload/SetupPayload.h b/src/setup_payload/SetupPayload.h
index 5e503ae..4892e9e 100644
--- a/src/setup_payload/SetupPayload.h
+++ b/src/setup_payload/SetupPayload.h
@@ -120,6 +120,10 @@
     uint16_t vendorID                   = 0;
     uint16_t productID                  = 0;
     CommissioningFlow commissioningFlow = CommissioningFlow::kStandard;
+    // rendezvousInformation is Optional, because a payload parsed from a manual
+    // numeric code would not have any rendezvousInformation available.  A
+    // payload parsed from a QR code would always have a value for
+    // rendezvousInformation.
     Optional<RendezvousInformationFlags> rendezvousInformation;
     SetupDiscriminator discriminator;
     uint32_t setUpPINCode = 0;