Remove unnecessary @file doxygen comments

Now that the documentation uses Sphinx, the @file annotations serve no
purpose.
This commit is contained in:
Oliver Hamlet
2016-10-08 12:10:21 +01:00
parent 880c2f29b8
commit ce57208859
11 changed files with 0 additions and 55 deletions
-4
View File
@@ -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
-5
View File
@@ -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 {
-5
View File
@@ -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
-4
View File
@@ -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.
-6
View File
@@ -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.
*/
-5
View File
@@ -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
-5
View File
@@ -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
-5
View File
@@ -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.
*/
-6
View File
@@ -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.
*/
-5
View File
@@ -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
-5
View File
@@ -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 {