From 20b6f2a4ea52462f1fa8a3b6014900ea52d7b4f3 Mon Sep 17 00:00:00 2001
From: Harsh Bhikadia <harsh.bhikadiya@gmail.com>
Date: Thu, 1 Apr 2021 00:20:59 +0530
Subject: [PATCH] [doc] added dart type mapping in declaration comment
 (flutter/engine#25329)

---
 .../include/flutter/encodable_value.h              | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/engine/src/flutter/shell/platform/common/client_wrapper/include/flutter/encodable_value.h b/engine/src/flutter/shell/platform/common/client_wrapper/include/flutter/encodable_value.h
index 82d9b69769d..1fbbe7e552b 100644
--- a/engine/src/flutter/shell/platform/common/client_wrapper/include/flutter/encodable_value.h
+++ b/engine/src/flutter/shell/platform/common/client_wrapper/include/flutter/encodable_value.h
@@ -144,6 +144,20 @@ using EncodableValueVariant = std::variant<std::monostate,
 //
 // The order/indexes of the variant types is part of the API surface, and is
 // guaranteed not to change.
+//
+// The variant types are mapped with Dart types in following ways:
+// std::monostate       -> null
+// bool                 -> bool
+// int32_t              -> int
+// int64_t              -> int
+// double               -> double
+// std::string          -> String
+// std::vector<uint8_t> -> Uint8List
+// std::vector<int32_t> -> Int32List
+// std::vector<int64_t> -> Int64List
+// std::vector<double>  -> Float64List
+// EncodableList        -> List
+// EncodableMap         -> Map
 class EncodableValue : public internal::EncodableValueVariant {
  public:
   // Rely on std::variant for most of the constructors/operators.