mirror of
https://github.com/loot/libloot.git
synced 2026-07-27 14:16:01 -07:00
Fix a few incorrect doc comments
This commit is contained in:
@@ -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<Group> 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<Group> GetUserGroups() const = 0;
|
||||
|
||||
@@ -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"),
|
||||
|
||||
Reference in New Issue
Block a user