From a9d323eb7e2044700d285cfbdb1ee4ba73ac9bd2 Mon Sep 17 00:00:00 2001 From: Oliver Hamlet Date: Sat, 4 Apr 2026 17:57:19 +0100 Subject: [PATCH] Fix C++ header doc comments Doxygen warned about these. --- cpp/include/loot/database_interface.h | 33 +++++++++++++++---- .../loot/metadata/plugin_cleaning_data.h | 2 ++ 2 files changed, 28 insertions(+), 7 deletions(-) diff --git a/cpp/include/loot/database_interface.h b/cpp/include/loot/database_interface.h index 1802e3f6..269ecce3 100644 --- a/cpp/include/loot/database_interface.h +++ b/cpp/include/loot/database_interface.h @@ -42,14 +42,35 @@ struct MetadataWriteOptionsImpl; class MetadataWriteOptions { public: /** - * @brief Creates a new set of options, all initially set to `false`. + * @brief Creates a new options object, with all options initially set to + * `false`. */ LOOT_API MetadataWriteOptions(); + + /** + * @brief Creates a new options object, copying the options' values from the + * given object. + */ LOOT_API MetadataWriteOptions(const MetadataWriteOptions&); + + /** + * @brief Creates a new options object, moving the options' values from the + * given object. + */ LOOT_API MetadataWriteOptions(MetadataWriteOptions&&) noexcept; + LOOT_API ~MetadataWriteOptions(); + /** + * @brief Assigns the options values of this object by copying them from the + * given object. + */ LOOT_API MetadataWriteOptions& operator=(const MetadataWriteOptions&); + + /** + * @brief Assigns the options values of this object by moving them from the + * given object. + */ LOOT_API MetadataWriteOptions& operator=(MetadataWriteOptions&&) noexcept; /** @@ -184,9 +205,8 @@ public: * Writes a metadata file containing all loaded user-added metadata. * @param outputFile * The path to which the file shall be written. - * @param overwrite - * If `false` and `outputFile` already exists, no data will be - * written. Otherwise, data will be written. + * @param options + * The configuration options to use when writing the file. */ virtual void WriteUserMetadata(const std::filesystem::path& outputFile, const MetadataWriteOptions& options) const = 0; @@ -197,9 +217,8 @@ public: * info themselves. * @param outputFile * The path to which the file shall be written. - * @param overwrite - * If `false` and `outputFile` already exists, no data will be - * written. Otherwise, data will be written. + * @param options + * The configuration options to use when writing the file. */ virtual void WriteMinimalList(const std::filesystem::path& outputFile, const MetadataWriteOptions& options) const = 0; diff --git a/cpp/include/loot/metadata/plugin_cleaning_data.h b/cpp/include/loot/metadata/plugin_cleaning_data.h index 59da2f62..a9b4d4f2 100644 --- a/cpp/include/loot/metadata/plugin_cleaning_data.h +++ b/cpp/include/loot/metadata/plugin_cleaning_data.h @@ -73,6 +73,8 @@ public: * The number of deleted references found in the plugin. * @param nav * The number of deleted navmeshes found in the plugin. + * @param condition + * A condition string. */ LOOT_API explicit PluginCleaningData( uint32_t crc,