Fix headers in Doxygen output.

This commit is contained in:
tastytea 2020-01-04 12:04:47 +01:00
parent c0d5bd9537
commit 892f1c6f87
Signed by: tastytea
GPG Key ID: CFC39497F1B26E07
6 changed files with 14 additions and 2 deletions

View File

@ -31,12 +31,14 @@ using std::variant;
* @brief Holds API endpoints. * @brief Holds API endpoints.
* *
* @since 0.1.0 * @since 0.1.0
*
* @headerfile api.hpp mastodonpp/api.hpp
*/ */
class API class API
{ {
public: public:
/*! /*!
* @brief An enumeration of all v1 API endpoints. * @brief An enumeration of all v1 %API endpoints.
* *
* The original `/` are substituted with `_`. * The original `/` are substituted with `_`.
* *
@ -48,7 +50,7 @@ public:
}; };
/*! /*!
* @brief An enumeration of all v2 API endpoints. * @brief An enumeration of all v2 %API endpoints.
* *
* The original `/` are substituted with `_`. * The original `/` are substituted with `_`.
* *

View File

@ -34,6 +34,8 @@ using std::string;
* @brief Exception for libcurl errors. * @brief Exception for libcurl errors.
* *
* @since 0.1.0 * @since 0.1.0
*
* @headerfile exceptions.hpp mastodonpp/exceptions.hpp
*/ */
class CURLException : public exception class CURLException : public exception
{ {

View File

@ -30,6 +30,8 @@ using std::string;
* @brief Holds the hostname and access token of an instance. * @brief Holds the hostname and access token of an instance.
* *
* @since 0.1.0 * @since 0.1.0
*
* @headerfile instance.hpp mastodonpp/instance.hpp
*/ */
class Instance class Instance
{ {

View File

@ -24,6 +24,8 @@
#include "return_types.hpp" #include "return_types.hpp"
/*! /*!
* @headerfile mastodonpp.hpp mastodonpp/mastodonpp.hpp
*
* @mainpage mastodonpp Reference * @mainpage mastodonpp Reference
* *
* @section using Using the library * @section using Using the library

View File

@ -32,6 +32,8 @@ using std::string;
* @brief Used to make a request to the Mastodon API. * @brief Used to make a request to the Mastodon API.
* *
* @since 0.1.0 * @since 0.1.0
*
* @headerfile request.hpp mastodonpp/request.hpp
*/ */
class Request class Request
{ {

View File

@ -34,6 +34,8 @@ using std::string_view;
* *
* @since 0.1.0 * @since 0.1.0
* *
* @headerfile return_types.hpp mastodonpp/return_types.hpp
*
* @section error Error codes * @section error Error codes
* | Code | Explanation | * | Code | Explanation |
* | --------: |:-------------------------------------------------------------| * | --------: |:-------------------------------------------------------------|