Skip to content

Commit

Permalink
docs: Altered minimum gcc version for Coro, fixed docs issues (#1173)
Browse files Browse the repository at this point in the history
  • Loading branch information
braindigitalis authored Jul 3, 2024
2 parents 9ddd55b + 15d5993 commit 8c8d3e9
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docpages/include/coro_warn.dox
Original file line number Diff line number Diff line change
@@ -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 <a href="https://github.com/brainboxdotcc/DPP/issues">GitHub Issues</a> or to our <a href="https://discord.gg/dpp">Discord Server</a>.
\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 <a href="https://github.com/brainboxdotcc/DPP/issues">GitHub Issues</a> or to our <a href="https://discord.gg/dpp">Discord Server</a>.
11 changes: 7 additions & 4 deletions include/dpp/message.h
Original file line number Diff line number Diff line change
Expand Up @@ -578,7 +578,7 @@ class DPP_EXPORT component : public json_interface<component> {
* @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);
Expand Down Expand Up @@ -662,9 +662,12 @@ class DPP_EXPORT component : public json_interface<component> {

/**
* @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.
*
* @warning 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
Expand Down

0 comments on commit 8c8d3e9

Please sign in to comment.