From 2488478a1232ae359d0af47cbb053c8bd460efd6 Mon Sep 17 00:00:00 2001 From: Ichthyostega Date: Tue, 13 Aug 2013 01:27:37 +0200 Subject: [PATCH] file-level comment for time values a recent discussion showed that it is rather likely for a reader new to the whole time handling framework to encounter this header first.... --- src/lib/time/timevalue.hpp | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/src/lib/time/timevalue.hpp b/src/lib/time/timevalue.hpp index e0b06a86f..3dc688d86 100644 --- a/src/lib/time/timevalue.hpp +++ b/src/lib/time/timevalue.hpp @@ -20,6 +20,23 @@ */ +/** @file timevalue.hpp + ** a family of time value like entities and their relationships. + ** This is the foundation for the Lumiera time handling framework. On the implementation + ** level, time values are represented as 64bit integer values \c gavl_time_t. But for the + ** actual use, we create several kinds of time "values", based on their logical properties. + ** These time values are considered to be fixed (immutable) values, which may only be + ** created through some well defined construction paths, and any time based calculation + ** is forced to go through our time calculation library. This is prerequisite for + ** the definition of frame aligned time values and time code representation + ** implemented as display format based on these frame quantised time values. + ** + ** @see time.h basic time calculation library functions + ** @see timequant.hpp + ** @see TimeValue_test + ** + */ + #ifndef LIB_TIME_TIMEVALUE_H #define LIB_TIME_TIMEVALUE_H