From 3b67d1f0052a4572f5ac9b3853cb7ddd1504e471 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Silvio=20Br=C3=A4ndle?= Date: Thu, 23 Jan 2025 18:19:11 +0000 Subject: [PATCH] Add comments --- cpp/src/phonenumbers/phonecontextparser.h | 8 ++++++++ cpp/src/phonenumbers/phonenumbernormalizer.h | 1 + 2 files changed, 9 insertions(+) diff --git a/cpp/src/phonenumbers/phonecontextparser.h b/cpp/src/phonenumbers/phonecontextparser.h index 007fd0271b..4538867238 100644 --- a/cpp/src/phonenumbers/phonecontextparser.h +++ b/cpp/src/phonenumbers/phonecontextparser.h @@ -27,6 +27,7 @@ namespace i18n { namespace phonenumbers { +// Parses the phone-context parameter of a phone number in RFC3966 format. class PhoneContextParser { friend class PhoneNumberUtil; friend class PhoneContextParserTest; @@ -45,6 +46,13 @@ class PhoneContextParser { std::shared_ptr reg_exps, std::shared_ptr normalizer); + // Parses the phone-context parameter of a phone number in RFC3966 format. + // If the phone-context parameter is not present, returns std::nullopt. If it + // is present but invalid, returns an error status. If it is present and + // valid, returns a PhoneContext object. This object contains the raw value of + // the phone-context parameter. Additionally, if the phone-context is exactly + // and only a + followed by a valid country code, it also contains the country + // code. absl::StatusOr> Parse( absl::string_view phone_number); diff --git a/cpp/src/phonenumbers/phonenumbernormalizer.h b/cpp/src/phonenumbers/phonenumbernormalizer.h index b25da096b9..0c2c14201d 100644 --- a/cpp/src/phonenumbers/phonenumbernormalizer.h +++ b/cpp/src/phonenumbers/phonenumbernormalizer.h @@ -23,6 +23,7 @@ namespace i18n { namespace phonenumbers { +// Util class to normalize phone numbers. class PhoneNumberNormalizer { friend class AsYouTypeFormatter; friend class PhoneContextParser;