From 38eb4d36de031fac7fdd493940919a042a60e858 Mon Sep 17 00:00:00 2001 From: Thomas Harte Date: Sun, 1 Jan 2023 22:18:39 -0500 Subject: [PATCH] Better explain cumulative nature of @c to_internal. --- Components/9918/Implementation/ClockConverter.hpp | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/Components/9918/Implementation/ClockConverter.hpp b/Components/9918/Implementation/ClockConverter.hpp index 2307d7eed..d11aed510 100644 --- a/Components/9918/Implementation/ClockConverter.hpp +++ b/Components/9918/Implementation/ClockConverter.hpp @@ -44,8 +44,9 @@ namespace TMS { template 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.