Skip to content

📝 Document scheduled_context constructor and methods#84

Merged
kammce merged 1 commit intomainfrom
scheduler-comments
Mar 27, 2026
Merged

📝 Document scheduled_context constructor and methods#84
kammce merged 1 commit intomainfrom
scheduler-comments

Conversation

@kammce
Copy link
Copy Markdown
Member

@kammce kammce commented Mar 27, 2026

📝 Document scheduled_context constructor and methods

Add comprehensive Doxygen documentation for:

  • scheduled_context constructor: explains listener registration and wake deadline initialization
  • refresh(Clock): documents wake deadline recalculation based on blocking state
  • refresh(Clock, time_point&): documents deadline refresh with global soonest time update
  • resume(Clock, time_point&): clarifies deadline checking, context resumption, and state refresh
  • is_ready(): explains readiness check for contexts not blocked by time or I/O

Also remove the unused assign() and operator< functions, move soonest wake
time tracking into resume() and refresh(), and add clarifying comments to
run_until_done_impl's scheduling loop.

Add comprehensive Doxygen documentation for:
- scheduled_context constructor: explains listener registration and wake deadline initialization
- refresh(Clock): documents wake deadline recalculation based on blocking state
- refresh(Clock, time_point&): documents deadline refresh with global soonest time update
- resume(Clock, time_point&): clarifies deadline checking, context resumption, and state refresh
- is_ready(): explains readiness check for contexts not blocked by time or I/O

Also remove the unused assign() and operator< functions, move soonest wake
time tracking into resume() and refresh(), and add clarifying comments to
run_until_done_impl's scheduling loop.
@kammce kammce merged commit 5cd5f1e into main Mar 27, 2026
8 checks passed
@kammce kammce deleted the scheduler-comments branch March 27, 2026 03:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant