Remove Doxygen return tag from constructors

This commit is contained in:
Oliver Hamlet
2025-05-16 23:28:00 +01:00
parent 5e4210b878
commit 03c83ad62f
10 changed files with 0 additions and 22 deletions
@@ -38,7 +38,6 @@ class ConditionalMetadata {
public:
/**
* Construct a ConditionalMetadata object with an empty condition string.
* @return A ConditionalMetadata object.
*/
LOOT_API ConditionalMetadata() = default;
@@ -47,7 +46,6 @@ public:
* @param condition
* A condition string, as defined in the LOOT metadata syntax
* documentation.
* @return A ConditionalMetadata object.
*/
LOOT_API explicit ConditionalMetadata(std::string_view condition);
-2
View File
@@ -40,7 +40,6 @@ class File : public ConditionalMetadata {
public:
/**
* Construct a File with blank name, display and condition strings.
* @return A File object.
*/
LOOT_API File() = default;
@@ -60,7 +59,6 @@ public:
* @param constraint
* A condition string that must evaluate to true for the file's existence
* to be recognised.
* @return A File object.
*/
LOOT_API explicit File(std::string_view name,
std::string_view display = "",
-2
View File
@@ -37,13 +37,11 @@ class Filename {
public:
/**
* Construct a Filename using an empty string.
* @return A Filename object.
*/
LOOT_API Filename() = default;
/**
* Construct a Filename using the given string.
* @return A Filename object.
*/
LOOT_API explicit Filename(std::string_view filename);
-2
View File
@@ -44,7 +44,6 @@ public:
/**
* Construct a Group with the name "default" and an empty set of groups to
* load after.
* @return A Group object.
*/
LOOT_API Group() = default;
@@ -57,7 +56,6 @@ public:
* The names of groups this group loads after.
* @param description
* A description of the group.
* @return A Group object.
*/
LOOT_API explicit Group(std::string_view name,
const std::vector<std::string>& afterGroups = {},
-2
View File
@@ -38,7 +38,6 @@ class Location {
public:
/**
* Construct a Location with empty URL and name strings.
* @return A Location object.
*/
LOOT_API Location() = default;
@@ -48,7 +47,6 @@ public:
* The URL at which the plugin can be found.
* @param name
* A name for the URL, eg. the page or site name.
* @return A Location object.
*/
LOOT_API explicit Location(std::string_view url,
std::string_view name = "");
-3
View File
@@ -42,7 +42,6 @@ public:
/**
* Construct a Message object of type 'say' with blank content and condition
* strings.
* @return A Message object.
*/
LOOT_API Message() = default;
@@ -55,7 +54,6 @@ public:
* The English message content text.
* @param condition
* A condition string.
* @return A Message object.
*/
LOOT_API explicit Message(const MessageType type,
std::string_view content,
@@ -70,7 +68,6 @@ public:
* The message content. If multilingual, one language must be English.
* @param condition
* A condition string.
* @return A Message object.
*/
LOOT_API explicit Message(const MessageType type,
const std::vector<MessageContent>& content,
@@ -45,7 +45,6 @@ public:
/**
* Construct a MessageContent object with an empty English message string.
* @return A MessageContent object.
*/
LOOT_API MessageContent() = default;
@@ -55,7 +54,6 @@ public:
* The message text.
* @param language
* The language that the message is written in.
* @return A MessageContent object.
*/
LOOT_API explicit MessageContent(
std::string_view text,
@@ -43,7 +43,6 @@ public:
* Construct a PluginCleaningData object with zero CRC, ITM count, deleted
* reference count and deleted navmesh count values, an empty utility string
* and no detail.
* @return A PluginCleaningData object.
*/
LOOT_API PluginCleaningData() = default;
@@ -55,7 +54,6 @@ public:
* The CRC of a plugin.
* @param utility
* The utility that the plugin cleanliness was checked with.
* @return A PluginCleaningData object.
*/
LOOT_API explicit PluginCleaningData(uint32_t crc,
std::string_view utility);
@@ -75,7 +73,6 @@ public:
* The number of deleted references found in the plugin.
* @param nav
* The number of deleted navmeshes found in the plugin.
* @return A PluginCleaningData object.
*/
LOOT_API explicit PluginCleaningData(
uint32_t crc,
@@ -48,7 +48,6 @@ class PluginMetadata {
public:
/**
* Construct a PluginMetadata object with a blank plugin name and no metadata.
* @return A PluginMetadata object.
*/
LOOT_API PluginMetadata() = default;
@@ -57,7 +56,6 @@ public:
* given filename.
* @param name
* The filename of the plugin that the object is constructed for.
* @return A PluginMetadata object.
*/
LOOT_API explicit PluginMetadata(std::string_view name);
-2
View File
@@ -39,7 +39,6 @@ public:
/**
* Construct a Tag object with an empty tag name suggested for addition, with
* an empty condition string.
* @return A Tag object.
*/
LOOT_API explicit Tag() = default;
@@ -52,7 +51,6 @@ public:
* True if the tag should be added, false if it should be removed.
* @param condition
* A condition string.
* @return A Tag object.
*/
LOOT_API explicit Tag(std::string_view tag,
const bool isAddition = true,