From aab151210e86e6910b32d16fa644b2750257374e Mon Sep 17 00:00:00 2001
From: Jenn Nguyen <jenn@openrobotics.org>
Date: Thu, 26 Aug 2021 14:15:08 -0700
Subject: [PATCH] Added comment reminder to update functions (#677)

* added reminder to update functions

Signed-off-by: Jenn Nguyen <jenn@openrobotics.org>

* corrected comment

Signed-off-by: Jenn Nguyen <jenn@openrobotics.org>

* TODO to Note

Signed-off-by: Jenn Nguyen <jenn@openrobotics.org>
---
 include/sdf/Param.hh | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/include/sdf/Param.hh b/include/sdf/Param.hh
index bcb74cdc4..36506c7e7 100644
--- a/include/sdf/Param.hh
+++ b/include/sdf/Param.hh
@@ -244,6 +244,8 @@ namespace sdf
 
     /// \def ParamVariant
     /// \brief Variant type def.
+    /// Note: When a new variant is added, add variant to functions
+    /// ParamPrivate::TypeToString and ParamPrivate::ValueFromStringImpl
     public: typedef std::variant<bool, char, std::string, int, std::uint64_t,
                                    unsigned int, double, float, sdf::Time,
                                    ignition::math::Angle,