Add missing doxygen documentation in phone module (#499)

cieslarmichal · Jan 27, 2024 · 447b3a9 · 447b3a9
1 parent 59d5337
commit 447b3a9
Showing 1 changed file with 30 additions and 0 deletions.
diff --git 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();
 
     /**