From 03c83ad62f7e5d215d9c4bb34ebd321f55258ef4 Mon Sep 17 00:00:00 2001 From: Oliver Hamlet Date: Fri, 16 May 2025 23:08:10 +0100 Subject: [PATCH] Remove Doxygen return tag from constructors --- cpp/include/loot/metadata/conditional_metadata.h | 2 -- cpp/include/loot/metadata/file.h | 2 -- cpp/include/loot/metadata/filename.h | 2 -- cpp/include/loot/metadata/group.h | 2 -- cpp/include/loot/metadata/location.h | 2 -- cpp/include/loot/metadata/message.h | 3 --- cpp/include/loot/metadata/message_content.h | 2 -- cpp/include/loot/metadata/plugin_cleaning_data.h | 3 --- cpp/include/loot/metadata/plugin_metadata.h | 2 -- cpp/include/loot/metadata/tag.h | 2 -- 10 files changed, 22 deletions(-) diff --git a/cpp/include/loot/metadata/conditional_metadata.h b/cpp/include/loot/metadata/conditional_metadata.h index e175670c..eddb0f1e 100644 --- a/cpp/include/loot/metadata/conditional_metadata.h +++ b/cpp/include/loot/metadata/conditional_metadata.h @@ -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); diff --git a/cpp/include/loot/metadata/file.h b/cpp/include/loot/metadata/file.h index c9ea1335..8868be2c 100644 --- a/cpp/include/loot/metadata/file.h +++ b/cpp/include/loot/metadata/file.h @@ -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 = "", diff --git a/cpp/include/loot/metadata/filename.h b/cpp/include/loot/metadata/filename.h index 81584fb5..fb5d2b47 100644 --- a/cpp/include/loot/metadata/filename.h +++ b/cpp/include/loot/metadata/filename.h @@ -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); diff --git a/cpp/include/loot/metadata/group.h b/cpp/include/loot/metadata/group.h index ba5a0071..2320dfe2 100644 --- a/cpp/include/loot/metadata/group.h +++ b/cpp/include/loot/metadata/group.h @@ -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& afterGroups = {}, diff --git a/cpp/include/loot/metadata/location.h b/cpp/include/loot/metadata/location.h index 7f32eca4..e8b0adf4 100644 --- a/cpp/include/loot/metadata/location.h +++ b/cpp/include/loot/metadata/location.h @@ -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 = ""); diff --git a/cpp/include/loot/metadata/message.h b/cpp/include/loot/metadata/message.h index 1509a640..ac43f029 100644 --- a/cpp/include/loot/metadata/message.h +++ b/cpp/include/loot/metadata/message.h @@ -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& content, diff --git a/cpp/include/loot/metadata/message_content.h b/cpp/include/loot/metadata/message_content.h index 9f23335f..ebabf765 100644 --- a/cpp/include/loot/metadata/message_content.h +++ b/cpp/include/loot/metadata/message_content.h @@ -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, diff --git a/cpp/include/loot/metadata/plugin_cleaning_data.h b/cpp/include/loot/metadata/plugin_cleaning_data.h index bb429927..87f10132 100644 --- a/cpp/include/loot/metadata/plugin_cleaning_data.h +++ b/cpp/include/loot/metadata/plugin_cleaning_data.h @@ -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, diff --git a/cpp/include/loot/metadata/plugin_metadata.h b/cpp/include/loot/metadata/plugin_metadata.h index 59619544..adcd9299 100644 --- a/cpp/include/loot/metadata/plugin_metadata.h +++ b/cpp/include/loot/metadata/plugin_metadata.h @@ -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); diff --git a/cpp/include/loot/metadata/tag.h b/cpp/include/loot/metadata/tag.h index 09f9249e..0bd6477a 100644 --- a/cpp/include/loot/metadata/tag.h +++ b/cpp/include/loot/metadata/tag.h @@ -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,