From c476f5191527694d2a38ca7a5ee7eb5f5ef7fdaf Mon Sep 17 00:00:00 2001
From: Boris Zbarsky <bzbarsky@apple.com>
Date: Mon, 3 Oct 2022 15:03:05 -0400
Subject: [PATCH] Document the rendezvousInformation field of SetupPayload
 better.

---
 src/setup_payload/SetupPayload.h | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/setup_payload/SetupPayload.h b/src/setup_payload/SetupPayload.h
index 5e503aea49f62c..4892e9ea0d2a23 100644
--- a/src/setup_payload/SetupPayload.h
+++ b/src/setup_payload/SetupPayload.h
@@ -120,6 +120,10 @@ struct PayloadContents
     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;