From 592664c78417b2f58c2c5cdc885e29ab209dd6ae Mon Sep 17 00:00:00 2001 From: Archie Jaskowicz Date: Tue, 18 Jun 2024 11:58:56 +0100 Subject: [PATCH 1/4] docs: corrected a couple things --- docpages/include/coro_warn.dox | 2 +- include/dpp/message.h | 10 ++++++---- 2 files changed, 7 insertions(+), 5 deletions(-) diff --git a/docpages/include/coro_warn.dox b/docpages/include/coro_warn.dox index debcb0f0dc..2bf9097b71 100644 --- a/docpages/include/coro_warn.dox +++ b/docpages/include/coro_warn.dox @@ -1 +1 @@ -\warning D++ Coroutines are a very new feature and are currently only supported by D++ on g++ 11, clang/LLVM 14, and MSVC 19.37 or above. Additionally, D++ must be built with the CMake option DPP_CORO, and your program must both define the macro DPP_CORO and use C++20 or above. The feature is experimental and may have bugs or even crashes, please report any to GitHub Issues or to our Discord Server. +\warning D++ Coroutines are a very new feature and are currently only supported by D++ on g++ 13, clang/LLVM 14, and MSVC 19.37 or above. Additionally, D++ must be built with the CMake option DPP_CORO, and your program must both define the macro DPP_CORO and use C++20 or above. The feature is experimental and may have bugs or even crashes, please report any to GitHub Issues or to our Discord Server. diff --git a/include/dpp/message.h b/include/dpp/message.h index d64b481e82..af90186404 100644 --- a/include/dpp/message.h +++ b/include/dpp/message.h @@ -555,7 +555,7 @@ class DPP_EXPORT component : public json_interface { * @brief Set the component to disabled. * Defaults to false on all created components. * - * @param disable True to disable, false to disable. + * @param disable True to disable the component, False to enable the component. * @return component& Reference to self */ component& set_disabled(bool disable); @@ -639,9 +639,11 @@ class DPP_EXPORT component : public json_interface { /** * @brief Set the emoji of the current sub-component. - * Only valid for buttons. Adding an emoji to a component - * will automatically set this components type to - * dpp::cot_button. One or both of name and id must be set. + * Only valid for buttons. + * + * @note Adding an emoji to a component will + * automatically set this components type to + * dpp::cot_button. **One or both of name and id must be set**. * For a built in unicode emoji, you only need set name, * and should set it to a unicode character e.g. "😄". * For custom emojis, set the name to the name of the emoji From 1c4174f8dca4d07a875cb28d27f04ea24ba79b4f Mon Sep 17 00:00:00 2001 From: Archie Jaskowicz Date: Tue, 18 Jun 2024 12:00:31 +0100 Subject: [PATCH 2/4] docs: slight change to set_emoji --- include/dpp/message.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/include/dpp/message.h b/include/dpp/message.h index af90186404..b484e280de 100644 --- a/include/dpp/message.h +++ b/include/dpp/message.h @@ -639,7 +639,8 @@ class DPP_EXPORT component : public json_interface { /** * @brief Set the emoji of the current sub-component. - * Only valid for buttons. + * + * @warning Only valid for buttons. * * @note Adding an emoji to a component will * automatically set this components type to From d44981dfd8fad0c24930ecc0778ebeae54a2853c Mon Sep 17 00:00:00 2001 From: Archie Jaskowicz Date: Wed, 19 Jun 2024 10:07:18 +0100 Subject: [PATCH 3/4] docs: lowered g++ version to 12 --- docpages/include/coro_warn.dox | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docpages/include/coro_warn.dox b/docpages/include/coro_warn.dox index 2bf9097b71..66f6d78ae1 100644 --- a/docpages/include/coro_warn.dox +++ b/docpages/include/coro_warn.dox @@ -1 +1 @@ -\warning D++ Coroutines are a very new feature and are currently only supported by D++ on g++ 13, clang/LLVM 14, and MSVC 19.37 or above. Additionally, D++ must be built with the CMake option DPP_CORO, and your program must both define the macro DPP_CORO and use C++20 or above. The feature is experimental and may have bugs or even crashes, please report any to GitHub Issues or to our Discord Server. +\warning D++ Coroutines are a very new feature and are currently only supported by D++ on g++ 12, clang/LLVM 14, and MSVC 19.37 or above. Additionally, D++ must be built with the CMake option DPP_CORO, and your program must both define the macro DPP_CORO and use C++20 or above. The feature is experimental and may have bugs or even crashes, please report any to GitHub Issues or to our Discord Server. From 715c2a19795ee376142ad2b87502b2a5896e3e95 Mon Sep 17 00:00:00 2001 From: Archie Jaskowicz Date: Wed, 19 Jun 2024 19:30:14 +0100 Subject: [PATCH 4/4] docs: change gcc version back to 13 --- docpages/include/coro_warn.dox | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docpages/include/coro_warn.dox b/docpages/include/coro_warn.dox index 66f6d78ae1..2bf9097b71 100644 --- a/docpages/include/coro_warn.dox +++ b/docpages/include/coro_warn.dox @@ -1 +1 @@ -\warning D++ Coroutines are a very new feature and are currently only supported by D++ on g++ 12, clang/LLVM 14, and MSVC 19.37 or above. Additionally, D++ must be built with the CMake option DPP_CORO, and your program must both define the macro DPP_CORO and use C++20 or above. The feature is experimental and may have bugs or even crashes, please report any to GitHub Issues or to our Discord Server. +\warning D++ Coroutines are a very new feature and are currently only supported by D++ on g++ 13, clang/LLVM 14, and MSVC 19.37 or above. Additionally, D++ must be built with the CMake option DPP_CORO, and your program must both define the macro DPP_CORO and use C++20 or above. The feature is experimental and may have bugs or even crashes, please report any to GitHub Issues or to our Discord Server.