From 054e404858506c94661a70b7fb6b8213c19b256a Mon Sep 17 00:00:00 2001 From: Martchus Date: Tue, 10 Nov 2015 21:27:40 +0100 Subject: [PATCH] added comments and move c'tor --- localeawarestring.h | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/localeawarestring.h b/localeawarestring.h index b140506..8a31196 100644 --- a/localeawarestring.h +++ b/localeawarestring.h @@ -8,10 +8,14 @@ namespace Media { +/*! + * \brief The LocaleAwareString class is a standard string with locale information (languages, countries). + */ class LIB_EXPORT LocaleAwareString : public std::string { public: LocaleAwareString(const std::string &value = std::string()); + LocaleAwareString(std::string &&value); ~LocaleAwareString(); const std::vector &languages() const; @@ -24,28 +28,53 @@ private: std::vector m_countries; }; +/*! + * \brief Constructs a new LocaleAwareString from the specified standard string. + */ inline LocaleAwareString::LocaleAwareString(const std::string &value) : std::string(value) {} +/*! + * \brief Constructs a new LocaleAwareString from the specified standard string. + */ +inline LocaleAwareString::LocaleAwareString(std::string &&value) : + std::string(value) +{} + +/*! + * \brief Destroys the instance. + */ inline LocaleAwareString::~LocaleAwareString() {} +/*! + * \brief Returns associated languages. + */ inline const std::vector &LocaleAwareString::languages() const { return m_languages; } +/*! + * \brief Returns associated languages. + */ inline std::vector &LocaleAwareString::languages() { return m_languages; } +/*! + * \brief Returns associated countries. + */ inline const std::vector &LocaleAwareString::countries() const { return m_countries; } +/*! + * \brief Returns associated countries. + */ inline std::vector &LocaleAwareString::countries() { return m_countries;