From ce572088591139cb9d97fcb8903d97721758ec30 Mon Sep 17 00:00:00 2001
From: Oliver Hamlet <oliver.hamlet@gmail.com>
Date: Thu, 6 Oct 2016 20:37:53 +0100
Subject: [PATCH] Remove unnecessary @file doxygen comments

Now that the documentation uses Sphinx, the @file annotations serve no
purpose.
---
 include/loot/api.h                | 4 ----
 include/loot/database_interface.h | 5 -----
 include/loot/error.h              | 5 -----
 include/loot/game_type.h          | 4 ----
 include/loot/language_code.h      | 6 ------
 include/loot/loot_version.h       | 5 -----
 include/loot/masterlist_info.h    | 5 -----
 include/loot/message_type.h       | 5 -----
 include/loot/plugin_cleanliness.h | 6 ------
 include/loot/plugin_tags.h        | 5 -----
 include/loot/simple_message.h     | 5 -----
 11 files changed, 55 deletions(-)

diff --git a/include/loot/api.h b/include/loot/api.h
index ff43a830..6ae95a38 100644
--- a/include/loot/api.h
+++ b/include/loot/api.h
@@ -21,10 +21,6 @@
     along with LOOT.  If not, see
     <https://www.gnu.org/licenses/>.
     */
-/**
- *  @file
- *  @brief The main include file for the API.
- */
 
 #ifndef LOOT_API_H
 #define LOOT_API_H
diff --git a/include/loot/database_interface.h b/include/loot/database_interface.h
index 1dac7470..d44018e2 100644
--- a/include/loot/database_interface.h
+++ b/include/loot/database_interface.h
@@ -33,11 +33,6 @@
 #include "loot/plugin_tags.h"
 #include "loot/simple_message.h"
 
-/**
- * @file
- * @brief Contains the DatabaseInterface class.
- */
-
 namespace loot {
 /** @brief The interface provided by API's database handle. */
 class DatabaseInterface {
diff --git a/include/loot/error.h b/include/loot/error.h
index 63c48bb3..555faf5d 100644
--- a/include/loot/error.h
+++ b/include/loot/error.h
@@ -28,11 +28,6 @@
 #include <exception>
 #include <string>
 
-/**
- * @file
- * @brief Contains the Error class used for some exceptions thrown.
- */
-
 namespace loot {
 /**
  * @brief A class that defines the type of objects thrown as errors by the LOOT
diff --git a/include/loot/game_type.h b/include/loot/game_type.h
index fcef2ad3..cb456679 100644
--- a/include/loot/game_type.h
+++ b/include/loot/game_type.h
@@ -25,10 +25,6 @@ along with LOOT.  If not, see
 #ifndef LOOT_GAME_TYPE
 #define LOOT_GAME_TYPE
 
-/**
- * @file
- * @brief Contains the GameType codes used when creating a database handle.
- */
 
 /**
  * The namespace used by the LOOT API.
diff --git a/include/loot/language_code.h b/include/loot/language_code.h
index d206a527..e73e4fd3 100644
--- a/include/loot/language_code.h
+++ b/include/loot/language_code.h
@@ -25,12 +25,6 @@ along with LOOT.  If not, see
 #ifndef LOOT_LANGUAGE_CODE
 #define LOOT_LANGUAGE_CODE
 
-/**
- * @file
- * @brief Contains the language codes used when evaluating masterlists and
- *        userlists.
- */
-
 /**
  * The namespace used by the LOOT API.
  */
diff --git a/include/loot/loot_version.h b/include/loot/loot_version.h
index fe60796a..ad45c6ab 100644
--- a/include/loot/loot_version.h
+++ b/include/loot/loot_version.h
@@ -29,11 +29,6 @@ along with LOOT.  If not, see
 
 #include "loot/api_decorator.h"
 
-/**
- * @file
- * @brief Contains the class used to get API version information.
- */
-
 namespace loot {
 /**
  * @brief A purely static class that provides information about the version of
diff --git a/include/loot/masterlist_info.h b/include/loot/masterlist_info.h
index c9adb2b7..0f3fe7d0 100644
--- a/include/loot/masterlist_info.h
+++ b/include/loot/masterlist_info.h
@@ -26,11 +26,6 @@
 
 #include <string>
 
-/**
- * @file
- * @brief Contains the MasterlistInfo structure.
- */
-
 namespace loot {
 /**
  * @brief A structure that holds data about a masterlist's source control
diff --git a/include/loot/message_type.h b/include/loot/message_type.h
index 7ef7aaa5..8739d4f8 100644
--- a/include/loot/message_type.h
+++ b/include/loot/message_type.h
@@ -25,11 +25,6 @@ along with LOOT.  If not, see
 #ifndef LOOT_MESSAGE_TYPE
 #define LOOT_MESSAGE_TYPE
 
-/**
- * @file
- * @brief Contains the message type codes used by the SimpleMessage structure.
- */
-
 /**
  * The namespace used by the LOOT API.
  */
diff --git a/include/loot/plugin_cleanliness.h b/include/loot/plugin_cleanliness.h
index e3713723..58f4a0b0 100644
--- a/include/loot/plugin_cleanliness.h
+++ b/include/loot/plugin_cleanliness.h
@@ -24,12 +24,6 @@
 #ifndef LOOT_PLUGIN_CLEANLINESS
 #define LOOT_PLUGIN_CLEANLINESS
 
-/**
- * @file
- * @brief Contains the plugin cleanliness codes used when getting the
- * cleanliness state of a plugin.
- */
-
 /**
  * The namespace used by the LOOT API.
  */
diff --git a/include/loot/plugin_tags.h b/include/loot/plugin_tags.h
index 55755c43..36c56cae 100644
--- a/include/loot/plugin_tags.h
+++ b/include/loot/plugin_tags.h
@@ -27,11 +27,6 @@
 #include <set>
 #include <string>
 
-/**
- * @file
- * @brief Contains the PluginTags structure.
- */
-
 namespace loot {
 /**
  * @brief A structure that holds data about the Bash Tag suggestions made by
diff --git a/include/loot/simple_message.h b/include/loot/simple_message.h
index 3ab1197d..3aaca1e1 100644
--- a/include/loot/simple_message.h
+++ b/include/loot/simple_message.h
@@ -26,11 +26,6 @@
 
 #include "loot/message_type.h"
 
-/**
- * @file
- * @brief Contains the SimpleMessage structure.
- */
-
 namespace loot {
 /** @brief A structure that holds the type of a message and the message string itself. */
 struct SimpleMessage {