-- Added doxygen comments to music.h for the newly added parameters.

cieslarmichal · Dec 3, 2024 · 920f010 · 920f010
1 parent 7514e91
commit 920f010
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/include/faker-cxx/music.h b/include/faker-cxx/music.h
@@ -10,6 +10,8 @@ namespace faker::music
 /**
  * @brief Returns a random artist.
  *
+ * @param locale The locale. Defaults to `Locale::en_US`.
+ *
  * @returns Artist.
  *
  * @code
@@ -21,6 +23,8 @@ FAKER_CXX_EXPORT std::string_view artist(Locale locale = Locale::en_US);
 /**
  * @brief Returns a random music genre.
  *
+ * @param locale The locale. Defaults to `Locale::en_US`.
+ *
  * @returns Music genre.
  *
  * @code
@@ -32,6 +36,8 @@ FAKER_CXX_EXPORT std::string_view genre(Locale locale = Locale::en_US);
 /**
  * @brief Returns a random song name.
  *
+ * @param locale The locale. Defaults to `Locale::en_US`.
+ *
  * @returns Song name.
  *
  * @code