From 190f9b22917e9c426209ae0b2a0ac96869b8176c Mon Sep 17 00:00:00 2001
From: Jonathan Diamond <jonathan@pointonenav.com>
Date: Tue, 15 Oct 2024 09:55:49 -0700
Subject: [PATCH] PR comments.

---
 .../fusion_engine/messages/configuration.h    | 21 ++++++++++++-------
 1 file changed, 13 insertions(+), 8 deletions(-)

diff --git a/src/point_one/fusion_engine/messages/configuration.h b/src/point_one/fusion_engine/messages/configuration.h
index f0bb4d9c..26c2c431 100644
--- a/src/point_one/fusion_engine/messages/configuration.h
+++ b/src/point_one/fusion_engine/messages/configuration.h
@@ -1480,22 +1480,19 @@ struct P1_ALIGNAS(4) ExportDataMessage {
  * See also @ref ExportDataMessage.
  *
  * Changes:
- * - Version 1: Added data_validity field.
+ * - Version 1: Added @ref data_validity field.
  * - Version 2: Changed data_validity to a @ref Response enum and added
  *              @ref source field.
- * - Version 3: Added flags field.
+ * - Version 3: Added @ref flags field.
  */
 struct P1_ALIGNAS(4) PlatformStorageDataMessage {
   static constexpr MessageType MESSAGE_TYPE =
       MessageType::PLATFORM_STORAGE_DATA;
   static constexpr uint8_t MESSAGE_VERSION = 3;
 
-  /**
-   * @ref DataType::USER_CONFIG flag that does not specify what platform the
-   * configuration corresponds to.
-   */
+  /** @ref DataType::USER_CONFIG the flags field is not set. */
   static constexpr uint8_t FLAG_USER_CONFIG_PLATFORM_NOT_SPECIFIED = 0;
-  /** @ref DataType::USER_CONFIG flag for posix platforms. */
+  /** @ref DataType::USER_CONFIG flag for POSIX platforms. */
   static constexpr uint8_t FLAG_USER_CONFIG_PLATFORM_POSIX = 1;
   /** @ref DataType::USER_CONFIG flag for embedded platforms. */
   static constexpr uint8_t FLAG_USER_CONFIG_PLATFORM_EMBEDDED = 2;
@@ -1516,7 +1513,15 @@ struct P1_ALIGNAS(4) PlatformStorageDataMessage {
    * ConfigurationSource::ACTIVE.
    */
   ConfigurationSource source = ConfigurationSource::ACTIVE;
-  /** @ref DataType specific flags. */
+  /**
+   * @ref DataType specific flags.
+   *
+   * Currently, only defined for @ref DataType::USER_CONFIG contents. This value
+   * can optionally set to one of the `FLAG_USER_CONFIG_PLATFORM_*` values to
+   * indicate which type of platform the UserConfig is valid for. This value
+   * can be left at `0` for backwards compatibility or to indicate the platform
+   * type is unknown.
+   */
   uint8_t flags = 0;
   /** Version of data contents. */
   DataVersion data_version;