mirror of
https://github.com/loot/libloot.git
synced 2026-07-27 14:16:01 -07:00
Remove unnecessary @file doxygen comments
Now that the documentation uses Sphinx, the @file annotations serve no purpose.
This commit is contained in:
@@ -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
|
||||
|
||||
@@ -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 {
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
*/
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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.
|
||||
*/
|
||||
|
||||
@@ -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.
|
||||
*/
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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 {
|
||||
|
||||
Reference in New Issue
Block a user