From c0a1cc472291c901de0e0de73ac96bd541e331aa Mon Sep 17 00:00:00 2001 From: Oliver Hamlet Date: Mon, 2 Apr 2018 16:25:32 +0100 Subject: [PATCH] Fix a few incorrect doc comments --- include/loot/database_interface.h | 8 ++++---- include/loot/exception/undefined_group_error.h | 7 ++----- 2 files changed, 6 insertions(+), 9 deletions(-) diff --git a/include/loot/database_interface.h b/include/loot/database_interface.h index 91bfa615..9d48818d 100644 --- a/include/loot/database_interface.h +++ b/include/loot/database_interface.h @@ -183,16 +183,16 @@ public: /** * @brief Gets the groups that are defined in the loaded metadata lists. + * @param includeUserMetadata + * If true, any group metadata present in the userlist is included in + * the returned metadata, otherwise the metadata returned only includes + * metadata from the masterlist. * @returns An unordered set of Group objects. */ virtual std::unordered_set GetGroups(bool includeUserMetadata = true) const = 0; /** * @brief Gets the groups that are defined or extended in the loaded userlist. - * @param includeUserMetadata - * If true, any group metadata present in the userlist is included in - * the returned metadata, otherwise the metadata returned only includes - * metadata from the masterlist. * @returns An unordered set of Group objects. */ virtual std::unordered_set GetUserGroups() const = 0; diff --git a/include/loot/exception/undefined_group_error.h b/include/loot/exception/undefined_group_error.h index 30e8208f..d18f4b56 100644 --- a/include/loot/exception/undefined_group_error.h +++ b/include/loot/exception/undefined_group_error.h @@ -34,11 +34,8 @@ namespace loot { class UndefinedGroupError : public std::runtime_error { public: /** - * @brief Construct an exception detailing a plugin graph cycle. - * @param firstPlugin A plugin in the cycle. - * @param lastPlugin Another plugin in the cycle. - * @param backCycle A string describing the path from lastPlugin to - * firstPlugin. + * @brief Construct an exception for an undefined group. + * @param groupName The name of the group that is undefined. */ UndefinedGroupError(const std::string& groupName) : std::runtime_error("The group \"" + groupName + "\" does not exist"),