diff --git a/doxygen-awesome-css b/doxygen-awesome-css index 8cea9a073e..00a52f6c74 160000 --- a/doxygen-awesome-css +++ b/doxygen-awesome-css @@ -1 +1 @@ -Subproject commit 8cea9a073ecd50a5b2c0958a3df100292d6c7374 +Subproject commit 00a52f6c74065ffbd836cbd791ddfe8edf2836b8 diff --git a/include/dpp/guild.h b/include/dpp/guild.h index 755b53befe..cbb394ce15 100644 --- a/include/dpp/guild.h +++ b/include/dpp/guild.h @@ -417,7 +417,9 @@ class DPP_EXPORT guild_member : public json_interface { protected: /** - * @brief Nickname, or empty string if they don't have a nickname on this guild + * @brief Nickname. + * + * @note Empty string if they don't have a nickname on this guild */ std::string nickname; @@ -445,9 +447,12 @@ class DPP_EXPORT guild_member : public json_interface { snowflake user_id; /** - * @brief User avatar (per-server avatar is a nitro only feature) + * @brief User avatar. + * + * @note Per-server avatar is a nitro only feature. */ utility::iconhash avatar; + /** * @brief Timestamp of when the time out will be removed; until then, they cannot interact with the guild */ @@ -707,7 +712,9 @@ struct DPP_EXPORT welcome_channel : public json_interface { std::string description; /** - * @brief The emoji name if custom, the unicode character if standard, or null if no emoji is set. + * @brief The emoji name. + * + * @note name if custom, the unicode character if standard, or null if no emoji is set. */ std::string emoji_name; @@ -852,8 +859,8 @@ enum guild_explicit_content_t : uint8_t { }; /** - * @brief MFA level for server. If set to elevated all moderators need MFA to perform specific - * actions such as kick or ban. + * @brief MFA level for server. + * If set to elevated all moderators need MFA to perform specific actions such as kick or ban. */ enum mfa_level_t : uint8_t { /** diff --git a/include/dpp/permissions.h b/include/dpp/permissions.h index a51702ef4d..22b1b555ba 100644 --- a/include/dpp/permissions.h +++ b/include/dpp/permissions.h @@ -235,8 +235,9 @@ enum permissions : uint64_t { p_use_embedded_activities = 0x08000000000, /** - * @brief Allows for timing out users to prevent them from sending or reacting - * to messages in chat and threads, and from speaking in voice and stage channels. + * @brief Allows for timing out users + * to prevent them from sending or reacting to messages in chat and threads, + * and from speaking in voice and stage channels. */ p_moderate_members = 0x10000000000, diff --git a/include/dpp/presence.h b/include/dpp/presence.h index cc507464e4..7515b14bac 100644 --- a/include/dpp/presence.h +++ b/include/dpp/presence.h @@ -339,12 +339,14 @@ struct DPP_EXPORT activity_party { snowflake id; /** - * @brief The party's current size. Used to show the party's current size. + * @brief The party's current size. + * Used to show the party's current size. */ int32_t current_size; /** - * @brief The party's maximum size. Used to show the party's maximum size. + * @brief The party's maximum size. + * Used to show the party's maximum size. */ int32_t maximum_size; @@ -358,12 +360,14 @@ struct DPP_EXPORT activity_party { class DPP_EXPORT activity { public: /** - * @brief Name of activity (e.g. "Fortnite", "Mr Boom's Firework Factory", etc). + * @brief Name of activity. + * e.g. "Fortnite", "Mr Boom's Firework Factory", etc. */ std::string name; /** - * @brief State of activity or the custom user status (e.g. "Waiting in lobby"). + * @brief State of activity or the custom user status. + * e.g. "Waiting in lobby". */ std::string state; @@ -415,17 +419,20 @@ class DPP_EXPORT activity { time_t created_at; /** - * @brief Start time. e.g. when game was started. + * @brief Start time. + * e.g. when game was started. */ time_t start; /** - * @brief End time, e.g. for songs on spotify. + * @brief End time. + * e.g. for songs on spotify. */ time_t end; /** - * @brief Creating application (e.g. a linked account on the user's client). + * @brief Creating application. + * e.g. a linked account on the user's client. */ snowflake application_id; @@ -519,7 +526,7 @@ class DPP_EXPORT presence : public json_interface { uint8_t flags; /** - * @brief List of activities + * @brief List of activities. */ std::vector activities; diff --git a/include/dpp/queues.h b/include/dpp/queues.h index e3f2640ed4..10a709ab56 100644 --- a/include/dpp/queues.h +++ b/include/dpp/queues.h @@ -114,12 +114,14 @@ struct DPP_EXPORT http_request_completion_t { std::multimap headers; /** - * @brief HTTP status (e.g. 200 = OK, 404 = Not found, 429 = Rate limited, etc). + * @brief HTTP status. + * e.g. 200 = OK, 404 = Not found, 429 = Rate limited, etc. */ uint16_t status = 0; /** - * @brief Error status (e.g. if the request could not connect at all). + * @brief Error status. + * e.g. if the request could not connect at all. */ http_error error = h_success; @@ -149,7 +151,7 @@ struct DPP_EXPORT http_request_completion_t { uint64_t ratelimit_retry_after = 0; /** - * @brief True if this request has caused us to be globally rate limited . + * @brief True if this request has caused us to be globally rate limited. */ bool ratelimit_global = false; @@ -230,7 +232,8 @@ class DPP_EXPORT http_request { bool non_discord; public: /** - * @brief Endpoint name e.g. /api/users. + * @brief Endpoint name + * e.g. /api/users. */ std::string endpoint; @@ -265,7 +268,8 @@ class DPP_EXPORT http_request { std::vector file_content; /** - * @brief Upload file mime types (application/octet-stream if unspecified). + * @brief Upload file mime types. + * application/octet-stream if unspecified. */ std::vector file_mimetypes;