Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: fix #399

Merged
merged 1 commit into from
Mar 7, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions components/runqueue/include/runqueue.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -43,20 +43,20 @@ namespace espp {
///
/// The RunQueue is thread-safe and can be used from multiple threads.
///
/// \warn Care should be taken to ensure that no functions in the queue are
/// blocking on each other, and all functions in the queue must return
/// (they cannot be infinite loops).
/// \warning Care should be taken to ensure that no functions in the queue are
/// blocking on each other, and all functions in the queue must return
/// (they cannot be infinite loops).
///
/// \warn Functions take a long time to run may delay or prevent the execution
/// of other functions in the queue. For this reason it's recommended to
/// try to keep the functions as short-lived as possible, and to
/// minimize the priorities of any functions which take longer to
/// execute.
/// \warning Functions take a long time to run may delay or prevent the
/// execution of other functions in the queue. For this reason it's
/// recommended to try to keep the functions as short-lived as
/// possible, and to minimize the priorities of any functions which
/// take longer to execute.
///
/// \section runq_ex0 RunQueue Example
/// \snippet runqueue_example.cpp runqueue example
/// \section runq_ex1 Multiple RunQueues Example
/// \snippet runqueue_example.cpp multiple runqueues example
/// \snippet runqueue_example.cpp multiple runqueue example
class RunQueue : public espp::BaseComponent {
public:
/// The type used to represent the priority of a function.
Expand Down