Index: sources/model/settings/MSettings.cpp =================================================================== diff -u -r821bf955d0ba7e028bccfee7c04ca77cf80a0bd4 -r94fc1cd187816ecbf176df26f9dc5601bf379f13 --- sources/model/settings/MSettings.cpp (.../MSettings.cpp) (revision 821bf955d0ba7e028bccfee7c04ca77cf80a0bd4) +++ sources/model/settings/MSettings.cpp (.../MSettings.cpp) (revision 94fc1cd187816ecbf176df26f9dc5601bf379f13) @@ -22,33 +22,68 @@ // name spaces using namespace Storage; +/*! + * \brief MSettings::MSettings + * \details The constructor + * \param parent + */ MSettings::MSettings(QObject *parent) : QObject(parent) { } +/*! + * \brief MSettings::groups + * \details Returns all the groups of the settings + * \return list of the groups as list of strings + */ QStringList MSettings::groups() { QMutexLocker locker(&_mutex); return _settings.keys(); } +/*! + * \brief MSettings::keys + * \details returns all keys in a group + * \param vGroup - the group to look for all the keys + * \return list of the keys in QString for the group vGroup + */ QStringList MSettings::keys(const QString &vGroup) { - Q_UNUSED(vGroup) const QMutexLocker locker(&_mutex); return _settings[vGroup].keys; } +/*! + * \brief MSettings::values + * \details returns all values in a group + * \param vGroup - the group to look for all the values + * \return list of the values in QString for the group vGroup + */ QVariantList MSettings::values(const QString &vGroup) { QMutexLocker locker(&_mutex); return _settings[vGroup].values; } +/*! + * \brief MSettings::location + * \details The locations where the settings have been read for the group vGroup + * \param vGroup - the group to look for the location + * \return the location in QString + */ QString MSettings::location(const QString &vGroup) { QMutexLocker locker(&_mutex); return _location[vGroup]; } +/*! + * \brief MSettings::add + * \details The function to be used to add elements in the settings + * \param vGroup - the group of the settings + * \param vKey - the key to be added under the group vGroup + * \param vValue - the value of the key to be added under group vGroup for the key vKey + * \param vLocation - the location of the setting data if is different will be set. + */ void MSettings::add(const QString &vGroup, const QString &vKey, const QVariant &vValue, const QString &vLocation) { QMutexLocker locker(&_mutex);