Document json_symbol.cpp

Author: NlightNFotis

src/util/json_symbol.cpp

@@ -13,6 +13,10 @@ Author: Chris Smowton, [email protected]
 #include <util/source_location.h>
 #include <util/type.h>
 
+/// Return string value for a given key if present in the json object.
+/// \param in: The json object that is getting fetched as a string.
+/// \param key: The key for the json value to be fetched.
+/// \return: A string value for the corresponding key.
 static const std::string &
 try_get_string(const jsont &in, const std::string &key)
 {
@@ -21,13 +25,20 @@ try_get_string(const jsont &in, const std::string &key)
   return in.value;
 }
 
+/// Return boolean value for a given key if present in the json object.
+/// \param in: The json object that is getting fetched as a boolean.
+/// \param key: The key for the json value to be fetched.
+/// \return: A boolean value for the corresponding key.
 static bool try_get_bool(const jsont &in, const std::string &key)
 {
   if(!(in.is_true() || in.is_false()))
     throw "symbol_from_json: expected bool for key '" + key + "'";
   return in.is_true();
 }
 
+/// Deserialise a json object to a symbolt.
+/// \param in: The json object that is getting fetched as a string.
+/// \return: A symbolt representing the json object.
 symbolt symbol_from_json(const jsont &in)
 {
   if(!in.is_object())