Skip to content

Commit c5a1a76

Browse files
committed
📚 Add links for run_triggers in index of identifiers
Problem: - `run_triggers` and `run_one_trigger` are documented but not included in the index of identifiers. Solution: - Add links.
1 parent f4f6120 commit c5a1a76

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

docs/synopsis.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,6 +150,8 @@ xref:schedulers.adoc#_time_scheduler[time_scheduler].
150150
* `timer_mgr::time_point_for` - a class template that can be specialized to specify a `time_point` type corresponding to a `duration` type
151151

152152
==== https://github.com/intel/cpp-baremetal-senders-and-receivers/blob/main/include/async/schedulers/trigger_manager.hpp[schedulers/trigger_manager.hpp]
153+
* `run_triggers<"name">()` - a function that runs all the named xref:schedulers.adoc#_trigger_scheduler[trigger_scheduler]s
154+
* `run_one_trigger<"name">()` - a function that runs one named xref:schedulers.adoc#_trigger_scheduler[trigger_scheduler] in FIFO order
153155
* `triggers<"name">` - a named trigger manager that is used with xref:schedulers.adoc#_trigger_scheduler[trigger_scheduler]
154156

155157
==== https://github.com/intel/cpp-baremetal-senders-and-receivers/blob/main/include/async/schedulers/trigger_scheduler.hpp[schedulers/trigger_scheduler.hpp]
@@ -273,6 +275,8 @@ contains traits and metaprogramming constructs used by many senders.
273275
* `requeue_policy::deferred` - https://github.com/intel/cpp-baremetal-senders-and-receivers/blob/main/include/async/schedulers/requeue_policy.hpp[`#include <async/schedulers/requeue_policy.hpp>`]
274276
* xref:sender_adaptors.adoc#_retry[`retry`] - https://github.com/intel/cpp-baremetal-senders-and-receivers/blob/main/include/async/retry.hpp[`#include <async/retry.hpp>`]
275277
* xref:sender_adaptors.adoc#_retry_until[`retry_until`] - https://github.com/intel/cpp-baremetal-senders-and-receivers/blob/main/include/async/retry.hpp[`#include <async/retry.hpp>`]
278+
* xref:schedulers.adoc#_trigger_scheduler[`run_one_trigger<"name">`] - https://github.com/intel/cpp-baremetal-senders-and-receivers/blob/main/include/async/schedulers/trigger_manager.hpp[`#include <async/schedulers/trigger_manager.hpp>`]
279+
* xref:schedulers.adoc#_trigger_scheduler[`run_triggers<"name">`] - https://github.com/intel/cpp-baremetal-senders-and-receivers/blob/main/include/async/schedulers/trigger_manager.hpp[`#include <async/schedulers/trigger_manager.hpp>`]
276280
* xref:schedulers.adoc#_runloop_scheduler[`runloop_scheduler`] - https://github.com/intel/cpp-baremetal-senders-and-receivers/blob/main/include/async/schedulers/runloop_scheduler.hpp[`#include <async/schedulers/runloop_scheduler.hpp>`]
277281
* `scheduler<S>` - https://github.com/intel/cpp-baremetal-senders-and-receivers/blob/main/include/async/concepts.hpp[`#include <async/concepts.hpp>`]
278282
* `sender<S>` - https://github.com/intel/cpp-baremetal-senders-and-receivers/blob/main/include/async/concepts.hpp[`#include <async/concepts.hpp>`]

0 commit comments

Comments
 (0)