1
0
mirror of https://github.com/TomHarte/CLK.git synced 2024-06-26 10:29:31 +00:00

Better explain cumulative nature of @c to_internal.

This commit is contained in:
Thomas Harte 2023-01-01 22:18:39 -05:00
parent 2bd20a0cf8
commit 38eb4d36de

View File

@ -44,8 +44,9 @@ namespace TMS {
template <Personality personality> class ClockConverter {
public:
/*!
Converts a number of extenral **half-cycles** to an internal number
of **cycles**.
Given that another @c source external **half-cycles** has occurred,
indicates how many complete internal **cycles** have additionally elapsed
since the last call to @c to_internal.
*/
int to_internal(int source) {
// Default behaviour is top apply a multiplication by 3/4.