Skip to content

Commit

Permalink
Document the rendezvousInformation field of SetupPayload better. (#23000
Browse files Browse the repository at this point in the history
)
  • Loading branch information
bzbarsky-apple authored and pull[bot] committed Nov 28, 2022
1 parent 12daff6 commit 3321345
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/setup_payload/SetupPayload.h
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down

0 comments on commit 3321345

Please sign in to comment.