Document the rendezvousInformation field of SetupPayload better. (#23000

)
project-chip · Oct 3, 2022 · ed2b697 · ed2b697
1 parent dab3e8f
commit ed2b697
Showing 1 changed file with 4 additions and 0 deletions.
diff --git 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;