Rahix / avr-hal

embedded-hal abstractions for AVR microcontrollers
Apache License 2.0
1.23k stars 216 forks source link

Document clock type design in more detail #532

Open Rahix opened 3 months ago

Rahix commented 3 months ago

From #443.

Right now, the clock types are used across the HAL, but there is no real documentation anywhere which explains how these clock types are intended to be used. We should give more examples on how this works and especially also document how one could migrate from the "hidden" clock API of arduino-hal to the explicit clock API of e.g. atmega-hal.

Rahix commented 2 months ago

Improved documentation in commit 75820c55c2ba ("generic: Improve documentation of clock module").

Still need to document how migration from arduino-hal to atmega-hal would work.