From 3f6424930ad966f6bbc839dd2e2fc612ec1e47f1 Mon Sep 17 00:00:00 2001
From: Lorenzo Blasa <lblasa@meta.com>
Date: Wed, 21 Jun 2023 13:33:10 -0700
Subject: [PATCH] Add resetState documentation

Summary:
Add documentation to `ConnectionContextStore::resetState`.

Useful to have, I guess.

Reviewed By: passy

Differential Revision: D46849937

fbshipit-source-id: 7dec76e23b566f460f0b22e0fa14b73e16a142f0
---
 xplat/Flipper/ConnectionContextStore.h | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/xplat/Flipper/ConnectionContextStore.h b/xplat/Flipper/ConnectionContextStore.h
index f5fdcc2c8..b1e366bce 100644
--- a/xplat/Flipper/ConnectionContextStore.h
+++ b/xplat/Flipper/ConnectionContextStore.h
@@ -38,6 +38,16 @@ class ConnectionContextStore {
    */
   folly::Optional<FlipperCertificateExchangeMedium> getLastKnownMedium();
   void storeConnectionConfig(folly::dynamic& config);
+  /**
+   * Reset state just removes all certificate exchange related files stored on
+   * the client. These are:
+   * - Certificate Sign Request (CSR)
+   * - CA Certificate
+   * - Server Certificate
+   * - Client Certificate
+   * - Client Key
+   * - Configuration file (includes device identifier)
+   */
   bool resetState();
 
   /** Convert and save to disk the existing certificate to PKCS #12 format.