From 447b3a9588af51e0ef0e9ffa0a899f8456cd8e14 Mon Sep 17 00:00:00 2001
From: Wiktoria Peretiatkowicz <127852624+wkktoria@users.noreply.github.com>
Date: Sat, 27 Jan 2024 17:13:48 +0000
Subject: [PATCH] Add missing doxygen documentation in phone module (#499)

---
 include/faker-cxx/Phone.h | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/include/faker-cxx/Phone.h b/include/faker-cxx/Phone.h
index 19249bc90..764fb36af 100644
--- a/include/faker-cxx/Phone.h
+++ b/include/faker-cxx/Phone.h
@@ -25,8 +25,38 @@ class Phone
      * @endcode
      */
     static std::string number(std::optional<std::string> = std::nullopt);
+
+    /**
+     * @brief Returns a random phone platform.
+     *
+     * @returns Random phone platform.
+     *
+     * @code
+     * Phone::platform() // "iOS"
+     * @endcode
+     */
     static std::string platform();
+
+    /**
+     * @brief Returns a random phone model.
+     *
+     * @returns Random phone model.
+     *
+     * @code
+     * Phone::modelName() // "Samsung Galaxy S22"
+     * @endcode
+     */
     static std::string modelName();
+
+    /**
+     * @brief Returns a random phone manufacturer.
+     *
+     * @returns Random phone manufacturer.
+     *
+     * @code
+     * Phone::manufacturer() // "Sony"
+     * @endcode
+     */
     static std::string manufacturer();
 
     /**