Fix doxygen, and some code cleanup

project-chip · Feb 8, 2021 · 394d295 · 394d295
1 parent 19cd638
commit 394d295
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 10 deletions.
diff --git a/examples/all-clusters-app/esp32/main/main.cpp b/examples/all-clusters-app/esp32/main/main.cpp
@@ -261,7 +261,7 @@ class SetupListModel : public ListScreen::Model
         if (i == 0)
         {
             ConnectivityMgr().ClearWiFiStationProvision();
-            OpenDefaultPairingWindow(kResetAdmins);
+            OpenDefaultPairingWindow(ResetAdmins::kYes);
         }
     }
 

diff --git a/src/app/server/Server.cpp b/src/app/server/Server.cpp
@@ -211,7 +211,7 @@ class ServerCallback : public SecureSessionMgrDelegate
 
             if (err != CHIP_NO_ERROR)
             {
-                SuccessOrExit(err = OpenDefaultPairingWindow(kDoNotResetAdmins));
+                SuccessOrExit(err = OpenDefaultPairingWindow(ResetAdmins::kNo));
             }
             else
             {
@@ -325,7 +325,7 @@ SecureSessionMgr & chip::SessionManager()
     return gSessions;
 }
 
-CHIP_ERROR OpenDefaultPairingWindow(bool resetAdmins)
+CHIP_ERROR OpenDefaultPairingWindow(ResetAdmins resetAdmins)
 {
     gDeviceDiscriminatorCache.RestoreDiscriminator();
 
@@ -343,7 +343,7 @@ CHIP_ERROR OpenDefaultPairingWindow(bool resetAdmins)
     params.SetSetupPINCode(pinCode);
 #endif // CONFIG_NETWORK_LAYER_BLE
 
-    if (resetAdmins == kResetAdmins)
+    if (resetAdmins == ResetAdmins::kYes)
     {
         gNextAvailableAdminId = 0;
         gAdminPairings.Reset();
@@ -409,7 +409,7 @@ void InitServer(AppDelegate * delegate)
     }
     else
     {
-        SuccessOrExit(err = OpenDefaultPairingWindow(kResetAdmins));
+        SuccessOrExit(err = OpenDefaultPairingWindow(ResetAdmins::kYes));
     }
 
 #if CHIP_ENABLE_MDNS

diff --git a/src/app/server/Server.h b/src/app/server/Server.h
@@ -38,12 +38,15 @@ void InitServer(AppDelegate * delegate = nullptr);
 
 namespace chip {
 
-constexpr bool kResetAdmins      = true;
-constexpr bool kDoNotResetAdmins = false;
+enum class ResetAdmins
+{
+    kYes,
+    kNo,
+};
 
 } // namespace chip
 
 /**
  * Open the pairing window using default configured parameters.
  */
-CHIP_ERROR OpenDefaultPairingWindow(bool resetAdmins);
+CHIP_ERROR OpenDefaultPairingWindow(chip::ResetAdmins resetAdmins);
diff --git a/src/controller/CHIPDevice.h b/src/controller/CHIPDevice.h
@@ -241,9 +241,11 @@ class DLL_EXPORT Device
      *   The device will exit the pairing mode after a successful pairing, or after the given `timeout` time.
      *
      * @param[in] timeout         The pairing mode should terminate after this much time.
-     * @param[in] useToken        The device should use the provided onboarding token instead of the default
-     *                            pairing setup PIN and discriminator.
+     * @param[in] useToken        Generate an onboarding token and send it to the device. The device must
+     *                            use the provided onboarding token instead of the original pairing setup PIN
+     *                            and discriminator.
      * @param[in] discriminator   The discriminator that the device should use for advertising and pairing.
+     * @param[out] setupPayload   The setup payload corresponding to the generated onboarding token.
      *
      * @return CHIP_ERROR               CHIP_NO_ERROR on success, or corresponding error
      */