diff --git a/docs/user/locale/Country.dox b/docs/user/locale/Country.dox index 1e2438aa7b..1b64b64089 100644 --- a/docs/user/locale/Country.dox +++ b/docs/user/locale/Country.dox @@ -64,11 +64,16 @@ /*! - \fn bool BCountry::GetName(BString& name) const - \brief Get the name of the country. + \fn status_t BCountry::GetName(BString& name, + const BLanguage* displayLanguage = NULL) const + \brief Writes the country's name into the supplied BString. - Fills in the name parameter with the name of the country in the - language set by the user's locale. + \param name A reference to a BString to write the country name to. + \param displayLanguage The language to use when writing the name. Can be + \c NULL to use the language set by the user's locale. + + \returns A status code, B_OK if everything went fine, or an error code + otherwise. */